'1.0',
'info' => ['style' => 'RPC', 'product' => 'VoiceNavigator', 'version' => '2025-11-11'],
'directories' => [
'DeleteVariable',
'ExportScript',
'DeleteCloneVoice',
'PreviewVoice',
'UpdateCloneVoice',
'DeleteVoiceAccessProfile',
'CreateScript',
'ExportVocabulary',
'UpdateSubscription',
'GetVocabulary',
'ListNluModels',
'CreateVariable',
'ListVariable',
'ListVocabulary',
'CreateVoiceAccessProfile',
'ListVoices',
'ListVoiceEngines',
'DeleteVocabulary',
'DeleteScript',
'UpdateVoiceAccessProfile',
'ListScripts',
'ListScriptProfileTemplates',
'UpdateScript',
'GetSubscription',
'ImportVocabulary',
'ListCloneVoice',
'DisableSubscription',
'UpdateVocabulary',
'ListBackgroundMusics',
'CreateCloneVoice',
'ListCloneVoiceModels',
'ListVoiceAccessProfile',
'PublishScript',
'CreateVocabulary',
'UpdateVariable',
'GetScript',
'CreateScriptVersion',
'CreateLlmAccessProfile',
'ListLlmAccessProfiles',
'UpdateLlmAccessProfile',
'DeleteLlmAccessProfile',
'UpdateCallCenterProvider',
[
'children' => ['ListRealtimeInstanceStats', 'GetScriptTrendingReport', 'GetInstanceTrendingReport', 'GetRealtimeScriptStats', 'GetRealtimeInstanceStats', 'ListHistoricalScriptReport', 'ListHistoricalInstanceReport', 'ListCallDetailRecords', 'GetRecording'],
'type' => 'directory',
'title' => 'Report',
],
[
'children' => ['GenerateFileUploadParams', 'DeleteInstruction', 'CreateCallCenterProvider', 'EndSession', 'UpdateInstruction', 'ListCallCenterProviders', 'DeleteCallCenterProvider', 'CreateInstruction', 'ListInstructions', 'BridgeWebCall', 'Dialogue', 'GetDataChannelCredential', 'BeginSession', 'GetCallDetailRecord'],
'type' => 'directory',
'title' => 'Others',
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'BeginSession' => [
'methods' => ['post'],
'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => 'Instance ID '."\n", 'description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'maxLength' => 64, 'example' => '36e9a4cd-a821-4f78-86fa-a9a4aefeea2e'],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['title' => 'Scenario ID ', 'description' => 'The ID of the script.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '0a88e269-01f5-49ac-97af-5830f0ccb271'],
],
[
'name' => 'DraftVersion',
'in' => 'query',
'schema' => ['title' => 'Indicates whether it is a draft version '."\n", 'description' => 'Specifies whether to use the draft version of the script.', 'type' => 'boolean', 'required' => false, 'docRequired' => true, 'example' => 'false'],
],
[
'name' => 'VendorParams',
'in' => 'query',
'schema' => ['title' => 'Ingest endpoint parameters, JSON format: {"key1":"value1"} '."\n", 'description' => 'The vendor parameters.'."\n"
."\n"
.'> The value must be a JSON string. For example: `{"key1":"value1"}`', 'type' => 'string', 'required' => false, 'example' => '{"key1":"value1"}'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response object.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'POP request ID ', 'description' => 'The ID of the request. This is a common parameter. For more information, see [Common parameters](~~close~~).', 'type' => 'string', 'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD'],
'HttpStatusCode' => ['title' => 'HTTP status code. A value of 200 indicates that the HTTP request succeeded. ', 'description' => 'The HTTP status code. A value of 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['title' => 'HTTP response message ', 'description' => 'The response message.', 'type' => 'string', 'example' => 'SUCCESS'],
'Code' => ['title' => 'Business status code. OK indicates that the request succeeded. '."\n", 'description' => 'The business status code. A value of OK indicates that the business operation was successful.', 'type' => 'string', 'example' => 'OK'],
'Data' => [
'description' => 'The business data returned by the operation.',
'title' => 'Business Data ',
'type' => 'object',
'properties' => [
'Answer' => ['title' => 'Bot reply content ', 'description' => 'The content of the bot\'s response.', 'type' => 'string', 'example' => '您好，欢迎致电申通快递，请问您有什么问题吗？'],
'StreamEnd' => ['title' => 'Indicates whether the stream response has ended '."\n", 'description' => 'Indicates whether the streamed response is complete.', 'type' => 'boolean', 'example' => 'true'],
'SessionId' => ['title' => 'Session ID '."\n", 'description' => 'The ID of the session.', 'type' => 'string', 'example' => '07d72ea0-6e38-48d4-8371-14deaaba996f'],
'StreamId' => ['title' => 'Turn ID of the conversation ', 'description' => 'The ID of the conversation turn.', 'type' => 'string', 'example' => '1'],
'StartTime' => ['title' => 'Update Time '."\n", 'description' => 'The start time of the conversation turn.', 'type' => 'integer', 'format' => 'int64', 'example' => '1774858849987'],
'EndTime' => ['description' => 'The end time of the conversation turn.', 'type' => 'integer', 'format' => 'int64', 'example' => '1752283603978', 'title' => ''],
'ControlParamsList' => [
'description' => 'A list of control parameters.',
'type' => 'array',
'items' => [
'description' => 'A control parameter object.',
'type' => 'object',
'properties' => [
'Type' => ['title' => 'Control parameter type, enumeration values: '."\n"
.'HangUp: Hang up '."\n"
.'Transfer: Transfer '."\n"
.'GatherDtmf: Collect DTMF input '."\n"
.'Voice: Voice '."\n", 'description' => 'The type of the control parameter.'."\n"
."\n"
.'> - `HangUp`: Hangs up the call.'."\n"
.'>'."\n"
.'> - `Transfer`: Transfers the call.'."\n"
.'>'."\n"
.'> - `GatherDtmf`: Gathers DTMF input.'."\n"
.'>'."\n"
.'> - `Voice`: Plays a voice prompt.', 'type' => 'string', 'example' => 'Voice'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
'Params' => [
'description' => 'The dynamic error parameters.',
'type' => 'array',
'items' => ['description' => 'A dynamic error parameter.', 'type' => 'string', 'example' => '-', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Enable session '."\n",
'summary' => 'Starts a session.',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Answer\\": \\"您好，欢迎致电申通快递，请问您有什么问题吗？\\",\\n \\"StreamEnd\\": true,\\n \\"SessionId\\": \\"07d72ea0-6e38-48d4-8371-14deaaba996f\\",\\n \\"StreamId\\": \\"1\\",\\n \\"StartTime\\": 1774858849987,\\n \\"EndTime\\": 1752283603978,\\n \\"ControlParamsList\\": [\\n {\\n \\"Type\\": \\"Voice\\"\\n }\\n ]\\n },\\n \\"Params\\": [\\n \\"-\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'voicebot:BeginSession',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'BridgeWebCall' => [
'summary' => 'Initiates a web call.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'maxLength' => 64, 'example' => '36e9a4cd-a821-4f78-86fa-a9a4aefeea2e', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'The scenario ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '0a88e269-01f5-49ac-97af-5830f0ccb271', 'title' => ''],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['description' => 'The device ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'd4c38420-****-43bc-b001-56bfc274****', 'title' => ''],
],
[
'name' => 'Caller',
'in' => 'query',
'schema' => ['description' => 'The caller number.', 'type' => 'string', 'required' => false, 'example' => '010123*****', 'title' => ''],
],
[
'name' => 'TimeoutSeconds',
'in' => 'query',
'schema' => ['description' => 'The timeout period in seconds.'."\n"
."\n"
.'> - If a call does not connect within this timeout period, the system disconnects it. The default value is 60.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60', 'title' => ''],
],
[
'name' => 'Tags',
'in' => 'query',
'schema' => ['description' => 'Tags to attach to the call, specified as key-value pairs.', 'type' => 'string', 'required' => false, 'example' => '{"key":"value"}', 'title' => ''],
],
[
'name' => 'SampleRate',
'in' => 'query',
'schema' => ['description' => 'The sample rate.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '8000', 'title' => ''],
],
[
'name' => 'DraftVersion',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to use the test environment.'."\n"
."\n"
.'> The default value is false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'AccessChannelType',
'in' => 'query',
'schema' => ['description' => 'The channel type.'."\n"
."\n"
.'> - Text: The text testing window.'."\n"
.'>'."\n"
.'> - Test: The test window.'."\n"
.'>'."\n"
.'> - Trial: The trial link.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'Text', 'title' => ''],
],
[
'name' => 'AccessChannelId',
'in' => 'query',
'schema' => ['description' => 'The channel ID.'."\n"
."\n"
.'> This parameter is valid only when AccessChannelType is set to Text or Trial.', 'type' => 'string', 'required' => false, 'example' => '33606503-c22c-4547-a51c-dda5e8d87962', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response schema.',
'title' => '',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD'],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''],
'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Data' => [
'description' => 'The call details.',
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => '36e9a4cd-a821-4f78-86fa-a9a4aefeea2e', 'title' => ''],
'SessionId' => ['description' => 'The session ID.', 'type' => 'string', 'example' => 'f814f3ae-b2a7-44fb-883c-771221274673', 'title' => ''],
'ChannelId' => ['description' => 'The channel ID.', 'type' => 'string', 'example' => '1515602866088888___5ec8446df1e2495a97969e887ab9e748', 'title' => ''],
'ExpirationTime' => ['description' => 'The token expiration time.', 'type' => 'string', 'example' => '1774794266093', 'title' => ''],
'ServerUrl' => ['description' => 'The server URL.', 'type' => 'string', 'example' => 'wss://hz-voicebot.aliyuncs.com:**/audio', 'title' => ''],
'Token' => ['description' => 'The token.', 'type' => 'string', 'example' => '57aa3e9b11d2fa5736787cacf0408c1a', 'title' => ''],
],
'title' => '',
'example' => '',
],
'Params' => [
'description' => 'A list of error parameters.',
'type' => 'array',
'items' => ['description' => 'A dynamic error parameter.', 'type' => 'string', 'example' => '-', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Initiate a web call',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'voicebot:BridgeWebCall',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": {\\n \\"InstanceId\\": \\"36e9a4cd-a821-4f78-86fa-a9a4aefeea2e\\",\\n \\"SessionId\\": \\"f814f3ae-b2a7-44fb-883c-771221274673\\",\\n \\"ChannelId\\": \\"1515602866088888___5ec8446df1e2495a97969e887ab9e748\\",\\n \\"ExpirationTime\\": \\"1774794266093\\",\\n \\"ServerUrl\\": \\"wss://hz-voicebot.aliyuncs.com:**/audio\\",\\n \\"Token\\": \\"57aa3e9b11d2fa5736787cacf0408c1a\\"\\n },\\n \\"Params\\": [\\n \\"-\\"\\n ]\\n}","type":"json"}]',
'translator' => 'machine',
],
'CreateCallCenterProvider' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'maxLength' => 64, 'example' => '36e9a4cd-a821-4f78-86fa-a9a4aefeea2e', 'title' => ''],
],
[
'name' => 'ProviderType',
'in' => 'formData',
'schema' => [
'description' => 'The service provider type.'."\n"
."\n"
.'> - `CCC`: Cloud Contact Center'."\n"
.'>'."\n"
.'> - `CUSTOM`: customer-owned contact center',
'enumValueTitles' => ['CCC' => 'Cloud Contact Center', 'CUSTOM' => 'customer-owned contact center'],
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'CCC',
'title' => '',
],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => 'The service provider name.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '云联络中心内部服务提供商', 'title' => ''],
],
[
'name' => 'DisplayName',
'in' => 'query',
'schema' => ['description' => 'The display name for the service provider.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '云联络中心内部服务提供商', 'title' => ''],
],
[
'name' => 'ReferTo',
'in' => 'formData',
'schema' => ['description' => 'The address for the `Refer` transfer method.>This parameter is required if the transfer method is `Refer`.>', 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''],
],
[
'name' => 'TrunkId',
'in' => 'formData',
'schema' => ['description' => 'The trunk ID.'."\n"
."\n"
.'>'."\n"
."\n"
.'This parameter is required if the transfer method is `Bridge`.'."\n"
."\n"
.'>', 'type' => 'string', 'required' => false, 'example' => 'trunk-xxx', 'title' => ''],
],
[
'name' => 'Originator',
'in' => 'formData',
'schema' => ['description' => 'The calling number to use when the transfer method is `Bridge`.', 'type' => 'string', 'required' => false, 'example' => '010****', 'title' => ''],
],
[
'name' => 'Destination',
'in' => 'formData',
'schema' => ['description' => 'The destination number to use when the transfer method is `Bridge`.', 'type' => 'string', 'required' => false, 'example' => '153*********', 'title' => ''],
],
[
'name' => 'Extras',
'in' => 'formData',
'schema' => ['description' => 'Accompanying data'."\n"
.'>Format: k1=v1;k2=v2>', 'type' => 'string', 'required' => false, 'example' => 'key1=value1', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response object.',
'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD'],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Data' => ['description' => 'The ID of the created manual service provider.', 'type' => 'string', 'example' => 'xxxxxxxxx', 'title' => ''],
'Params' => [
'description' => 'The dynamic error parameters.',
'type' => 'array',
'items' => ['description' => 'The dynamic error parameters.', 'type' => 'string', 'example' => '[]', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Create Manual Service Provider',
'summary' => 'Creates a manual service provider.',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Success\\",\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": \\"xxxxxxxxx\\",\\n \\"Params\\": [\\n \\"[]\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:CreateCallCenterProvider',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'CreateCloneVoice' => [
'summary' => 'Creates a custom voice by cloning an existing audio file.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'da37319b-6c83-4268-9f19-814aed62e401', 'title' => ''],
],
[
'name' => 'FileKey',
'in' => 'formData',
'schema' => ['description' => 'The storage path of the audio file for cloning.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'voice_clone/音色克隆单元测试.wav', 'title' => ''],
],
[
'name' => 'Model',
'in' => 'formData',
'schema' => [
'description' => 'The model to use for voice cloning.',
'enumValueTitles' => ['CosyVoice' => 'CosyVoice', 'QwenVc' => 'QwenVc'],
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'CosyVoice',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request ', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => 'F132DDBA-66C4-5BD3-BF7E-9642FE877158'],
'HttpStatusCode' => ['description' => 'The HTTP status code of the response.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'Code' => ['description' => 'The result code of the request.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Data' => [
'description' => 'The object that contains information about the cloned voice.',
'type' => 'object',
'properties' => [
'CloneVoiceId' => ['description' => 'The ID of the generated cloned voice.', 'type' => 'string', 'example' => '8ee1160a-6999-478f-8df6-f33ef21f27d5', 'title' => ''],
'Voice' => ['description' => 'The identifier for the generated voice that can be used in subsequent synthesis requests.', 'type' => 'string', 'example' => 'cosyvoice-v3-plus-voicebot2-3666e4bbb2b94832ac4f4107b5804c34', 'title' => ''],
],
'title' => '',
'example' => '',
],
'Params' => [
'description' => 'A list of parameters related to the error message.',
'type' => 'array',
'items' => ['description' => 'A parameter related to the error message.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Create a clone voice ',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F132DDBA-66C4-5BD3-BF7E-9642FE877158\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": {\\n \\"CloneVoiceId\\": \\"8ee1160a-6999-478f-8df6-f33ef21f27d5\\",\\n \\"Voice\\": \\"cosyvoice-v3-plus-voicebot2-3666e4bbb2b94832ac4f4107b5804c34\\"\\n },\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'voicebot:CreateCloneVoice',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'CreateInstruction' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'maxLength' => 64, 'example' => '36e9a4cd-a821-4f78-86fa-a9a4aefeea2e', 'title' => ''],
],
[
'name' => 'Type',
'in' => 'formData',
'schema' => [
'description' => 'The instruction type.',
'enumValueTitles' => ['TRANSFER' => 'transfer', 'GATHER_DTMF' => 'gather DTMF'],
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'TRANSFER',
'title' => '',
],
],
[
'name' => 'Code',
'in' => 'formData',
'schema' => ['description' => 'The instruction code.'."\n"
.'>The code must be globally unique.>', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'Transfer00', 'title' => ''],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => 'The instruction name.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '转人工指令一', 'title' => ''],
],
[
'name' => 'Config',
'in' => 'formData',
'schema' => ['description' => 'The configuration for the instruction, in JSON format.'."\n"
."\n"
.'> - providerId: The ID of the call center provider. To obtain this ID, call the ListCallCenterProviders operation.'."\n"
.'>'."\n"
.'> - transferMethod: The method used to transfer the call. Valid values: BYE, BRIDGE, and REFER.'."\n"
.'>'."\n"
.'> - transferType: The transfer destination type. Valid values: External (an external number), Agent (an agent), and SkillGroup (a skill group).'."\n"
.'>'."\n"
.'> - transferTarget: The transfer destination. The value of this parameter depends on the value of transferType.'."\n"
.'>'."\n"
.'> - transferor: The caller ID displayed for the transferred call. If this parameter is empty, the system defaults to the original caller\'s number.'."\n"
.'>'."\n"
.'> - timeoutSeconds: The transfer timeout, in seconds. The default is 30.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '{'."\n"
.' "providerId": "xxxxxxxxx",'."\n"
.' "transferMethod": "BYE",'."\n"
.' "transferType": "External",'."\n"
.' "transferTarget": "152******",'."\n"
.' "transferor": "01*****",'."\n"
.' "timeoutSeconds": "10"'."\n"
.'}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response schema.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'ID of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD'],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''],
'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Data' => ['description' => 'The code of the created instruction.', 'type' => 'string', 'example' => 'Transfer00', 'title' => ''],
'Params' => [
'description' => 'The dynamic error parameters.',
'type' => 'array',
'items' => ['description' => 'A dynamic error parameter.', 'type' => 'string', 'example' => '36e9a4cd-a821-4f78-86fa-a9a4aefeea2e', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Creation of Instruction ',
'summary' => 'Digital Employee > Global Configuration > Add Instruction',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": \\"Transfer00\\",\\n \\"Params\\": [\\n \\"36e9a4cd-a821-4f78-86fa-a9a4aefeea2e\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:CreateInstruction',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'CreateLlmAccessProfile' => [
'summary' => 'Creates a configuration profile for a language model.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
],
[
'name' => 'Profile',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => 'The configuration profile.',
'type' => 'object',
'properties' => [
'ApiKey' => ['description' => 'The API key for the third-party model.', 'type' => 'string', 'required' => false, 'example' => '70tKleNtMGaaIem7us7Miw-Tf3kPzE6l', 'title' => ''],
'Endpoint' => ['description' => 'The endpoint for the third-party model.', 'type' => 'string', 'required' => false, 'example' => 'api.llm.enpoint.example.com', 'title' => ''],
'Name' => ['description' => 'The name of the configuration profile for the third-party model.', 'type' => 'string', 'required' => false, 'example' => '千问Omni', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response schema.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75BAAB9B-40B2-5FF5-A59A-7BCF8154C6EE'],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Data' => ['description' => 'The ID of the configuration profile for the third-party model.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66b', 'title' => ''],
'Params' => [
'description' => 'A list of parameters used in the error message.',
'type' => 'array',
'items' => ['description' => 'A parameter used in the error message.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Create third-party model configuration ',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75BAAB9B-40B2-5FF5-A59A-7BCF8154C6EE\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": \\"af81a389-91f0-4157-8d82-720edd02b66b\\",\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'voicebot:CreateLlmAccessProfile',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'CreateScript' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '36e9a4cd-a821-4f78-86fa-a9a4aefeea2e', 'title' => ''],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => 'The name of the script.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '导航测试实例', 'title' => ''],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['description' => 'The description of the script.', 'type' => 'string', 'maxLength' => 255, 'required' => false, 'example' => '第一个导航实例', 'title' => ''],
],
[
'name' => 'Concurrency',
'in' => 'formData',
'schema' => ['description' => 'The maximum number of concurrent conversations.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'exclusiveMaximum' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'NluEngine',
'in' => 'formData',
'schema' => [
'description' => 'The NLU engine to use. Valid values:'."\n"
."\n"
.'- `PROMPTS`: prompt mode'."\n"
."\n"
.'- `FUNCTION`: function mode'."\n"
."\n"
.'- `BEEBOT`: workflow mode',
'enumValueTitles' => ['PROMPTS' => 'PROMPTS', 'BEEBOT' => 'BEEBOT', 'FUNCTION' => 'FUNCTION'],
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'BEEBOT',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response object.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75BAAB9B-40B2-5FF5-A59A-7BCF8154C6EE'],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Data' => ['description' => 'The script ID.', 'type' => 'string', 'example' => '0a88e269-01f5-49ac-97af-5830f0ccb271', 'title' => ''],
'Params' => [
'description' => 'A list of dynamic parameters returned when an error occurs.',
'type' => 'array',
'items' => ['description' => 'A dynamic parameter returned when an error occurs.', 'type' => 'string', 'example' => '2fe96e9b-656a-4fa1-9890-e3db5927aaf7', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Create a scenario ',
'summary' => 'Creates a script.',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75BAAB9B-40B2-5FF5-A59A-7BCF8154C6EE\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": \\"0a88e269-01f5-49ac-97af-5830f0ccb271\\",\\n \\"Params\\": [\\n \\"2fe96e9b-656a-4fa1-9890-e3db5927aaf7\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'voicebot:CreateScript',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'CreateScriptVersion' => [
'summary' => 'Create a scenario configuration',
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'abb4aa26-3a8e-43dd-82f8-0c3898c9c67f', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the script.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '64241e64-190c-45d1-af66-06f51c07b090', 'title' => ''],
],
[
'name' => 'SourceVersionId',
'in' => 'formData',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'TranscriberConfig',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => 'The Automatic Speech Recognition (ASR) configuration.',
'type' => 'object',
'properties' => [
'NlsAccessType' => [
'description' => 'The ASR service invocation method.',
'enumValueTitles' => ['PROVIDED' => 'Use a third-party ASR service.', 'MANAGED' => 'Use a managed ASR service.'],
'type' => 'string',
'default' => 'MANAGED',
'required' => false,
'example' => 'MANAGED',
'enum' => ['AUTHORIZED', 'PROVIDED', 'MANAGED'],
'title' => '',
],
'NlsEngine' => [
'description' => 'The ASR engine.',
'enumValueTitles' => ['IFLYTEK' => '', 'VOLC' => '', 'BAILIAN' => ''],
'type' => 'string',
'default' => 'BAILIAN',
'required' => false,
'example' => 'BAILIAN',
'enum' => ['ALIYUN', 'BAILIAN', 'IFLYTEK', 'VOLC', 'LALAMOVE'],
'title' => '',
],
'NlsAccessProfile' => [
'description' => 'The configuration for the third-party ASR service.',
'type' => 'object',
'properties' => [
'AccessProfileId' => ['description' => 'The configuration ID for the third-party ASR service. This is required if `NlsAccessType` is set to `PROVIDED`.', 'type' => 'string', 'required' => false, 'example' => 'c2c9baae-9351-4c49-a8cb-6f24a83a8718', 'maxLength' => 64, 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'VocabularyId' => ['description' => 'The ID of the vocabulary. You can obtain this ID from the vocabulary management page.', 'type' => 'string', 'required' => false, 'example' => 'cd97223f-42f2-4cd9-95af-e734e2fe1fe3', 'maxLength' => 64, 'title' => ''],
'EndSilenceTimeout' => ['description' => 'The silence timeout in milliseconds (ms) for voice activity detection (VAD). A silence interval longer than this value marks the end of an utterance.', 'type' => 'integer', 'format' => 'int32', 'default' => '500', 'required' => false, 'maximum' => '2000', 'minimum' => '200', 'example' => '700', 'title' => ''],
'CustomizationId' => ['title' => 'Custom language model ID for ASR ', 'description' => 'The ID of the custom language model for ASR.', 'type' => 'string', 'required' => false, 'example' => 'cd97223f-42f2-4cd9-95af-e734e2fe1fe4', 'maxLength' => 64],
'SpeechNoiseThreshold' => ['description' => 'The noise threshold. The value ranges from -100 to 100.'."\n"
."\n"
.'Lower values (closer to -100) increase the likelihood of noise being interpreted as speech.'."\n"
."\n"
.'Higher values (closer to 100) increase the likelihood of speech being interpreted as noise.', 'type' => 'integer', 'format' => 'int32', 'default' => '0', 'required' => false, 'maximum' => '100', 'minimum' => '-100', 'example' => '0', 'title' => ''],
'Model' => [
'description' => 'The ASR model.',
'type' => 'string',
'default' => 'Paraformer',
'required' => false,
'example' => 'Paraformer',
'maxLength' => 32,
'enum' => ['Paraformer', 'Fun', 'Qwen'],
'title' => '',
],
'CorrectionRules' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Pattern' => ['description' => 'The word or phrase to correct.', 'type' => 'string', 'title' => '', 'example' => ''],
'Replacement' => ['description' => 'The replacement word or phrase.', 'type' => 'string', 'title' => '', 'example' => ''],
],
'description' => 'A correction rule.',
'title' => '',
'example' => '',
],
'description' => 'Rules for correcting ASR results.',
'title' => '',
'example' => '',
],
],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'SynthesizerConfig',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => 'The Text-to-Speech (TTS) configuration.',
'type' => 'object',
'properties' => [
'NlsAccessType' => [
'description' => 'The TTS service invocation method.',
'enumValueTitles' => ['PROVIDED' => 'Use a third-party TTS service.', 'MANAGED' => 'Use a managed TTS service.'],
'type' => 'string',
'default' => 'MANAGED',
'required' => false,
'example' => 'MANAGED',
'enum' => ['MANAGED', 'AUTHORIZED', 'PROVIDED'],
'title' => '',
],
'NlsEngine' => [
'description' => 'The TTS engine.',
'enumValueTitles' => ['IFLYTEK' => '', 'VOLC' => '', 'BAILIAN' => ''],
'type' => 'string',
'default' => 'BAILIAN',
'required' => false,
'example' => 'BAILIAN',
'enum' => ['ALIYUN', 'BAILIAN', 'VOLC', 'IFLYTEK', 'LALAMOVE'],
'title' => '',
],
'NlsAccessProfile' => [
'description' => 'The configuration for the third-party TTS service.',
'type' => 'object',
'properties' => [
'AccessProfileId' => ['description' => 'The configuration ID for the third-party TTS service. This is required if `NlsAccessType` is set to `PROVIDED`.', 'type' => 'string', 'required' => false, 'example' => 'c2c9baae-9351-4c49-a8cb-6f24a83a8718', 'maxLength' => 64, 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'Model' => [
'description' => 'The TTS model.',
'enumValueTitles' => ['CosyVoice' => '', 'Qwen' => '', 'iflytek-default' => '', 'seed-tts-2.0' => ''],
'type' => 'string',
'required' => false,
'example' => 'CosyVoice',
'maxLength' => 32,
'title' => '',
],
'Voice' => ['description' => 'The TTS voice.', 'type' => 'string', 'required' => false, 'example' => 'longanyang', 'maxLength' => 64, 'title' => ''],
'SpeechRate' => ['description' => 'The speech rate.
'."\n"
.'Range: -500 to 500.
'."\n"
.'Default: 0.
', 'type' => 'integer', 'format' => 'int32', 'default' => '0', 'required' => false, 'maximum' => '500', 'minimum' => '-500', 'example' => '0', 'title' => ''],
'Volume' => ['description' => 'The volume.
'."\n"
.'Range: 0 to 100.
'."\n"
.'Default: 50.
', 'type' => 'integer', 'format' => 'int32', 'default' => '50', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '50', 'title' => ''],
'PitchRate' => ['description' => 'The pitch.
'."\n"
.'Range: -500 to 500.
'."\n"
.'Default: 0.
', 'type' => 'integer', 'format' => 'int32', 'default' => '0', 'required' => false, 'maximum' => '500', 'minimum' => '-500', 'example' => '0', 'title' => ''],
'PronRules' => [
'description' => 'Pronunciation correction rules for TTS.',
'type' => 'array',
'items' => [
'description' => 'A pronunciation correction rule.',
'type' => 'object',
'properties' => [
'Pattern' => ['description' => 'The word or phrase that is prone to mispronunciation.', 'type' => 'string', 'required' => false, 'example' => '还钱', 'maxLength' => 5, 'title' => ''],
'Replacement' => ['description' => 'The text with the correct pronunciation.', 'type' => 'string', 'required' => false, 'example' => '环钱', 'maxLength' => 20, 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'title' => '',
'example' => '',
],
],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'ScriptProfile',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => 'The configuration for the conversation logic.',
'type' => 'object',
'properties' => [
'ChatbotId' => ['description' => 'The ID of the chatbot.
'."\n"
.'This parameter is required when `NluEngine` is set to `BEEBOT`.
', 'type' => 'string', 'example' => 'chatbot-cn-MQuyjjb666', 'required' => false, 'maxLength' => 32, 'title' => ''],
'AgentKey' => ['description' => 'The AgentKey of the chatbot.
'."\n"
.'This parameter is required when `NluEngine` is set to `BEEBOT`.
', 'type' => 'string', 'example' => '1309723684579735_p_beebot_public', 'required' => false, 'maxLength' => 64, 'title' => ''],
'FunctionMeta' => [
'description' => 'The Function Compute configuration.',
'type' => 'object',
'properties' => [
'RegionId' => ['description' => 'The region where the Function Compute service is deployed.
'."\n"
.'This parameter is required when `NluEngine` is set to `FUNCTION`.
', 'type' => 'string', 'example' => 'cn-hangzhou', 'required' => false, 'maxLength' => 16, 'title' => ''],
'FunctionId' => ['description' => 'The ID of the Function Compute function.
'."\n"
.'This parameter is required when `NluEngine` is set to `FUNCTION`.
', 'type' => 'string', 'example' => '9b752bbb-805a-4d3e-9013-eab5555c3fef', 'required' => false, 'maxLength' => 48, 'title' => ''],
'FunctionName' => ['description' => 'The name of the Function Compute function.
'."\n"
.'This parameter is required when `NluEngine` is set to `FUNCTION`.
', 'type' => 'string', 'required' => false, 'example' => 'my_funciton', 'maxLength' => 64, 'title' => ''],
'HttpTriggerUrl' => ['description' => 'The URL of the function trigger.
'."\n"
.'This parameter is required when `NluEngine` is set to `FUNCTION`.
', 'type' => 'string', 'example' => 'http://chat-xxxxx-v-yewiundukb.cn-hangzhou-xxx.run', 'required' => false, 'maxLength' => 128, 'title' => ''],
'HttpTriggerName' => ['description' => 'The name of the function trigger.
'."\n"
.'This parameter is required when `NluEngine` is set to `FUNCTION`.
', 'type' => 'string', 'required' => false, 'example' => 'defaultTrigger', 'maxLength' => 64, 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'Model' => ['description' => 'The conversation model.
'."\n"
.'This parameter is required when `NluEngine` is set to `PROMPTS`.
', 'type' => 'string', 'required' => false, 'example' => 'qwen-plus', 'maxLength' => 64, 'title' => ''],
'AgentProfile' => [
'description' => 'The conversation agent configuration.',
'type' => 'object',
'properties' => [
'ScriptProfileTemplateId' => [
'description' => 'The ID of the prompt template.',
'enumValueTitles' => ['CCC_PROMPTS_DEFAULT' => 'The default prompt template.', 'CCC_PROMPTS_DEFAULT_OPENING' => 'The default opening prompt template.', 'CCC_PROMPTS_SURVEY' => 'The survey prompt template.'],
'type' => 'string',
'required' => false,
'example' => 'CCC_PROMPTS_DEFAULT',
'maxLength' => 64,
'title' => '',
],
'PromptsJson' => ['description' => 'The prompts for the agent, in a JSON string format.', 'type' => 'string', 'required' => false, 'example' => '{\\"prompts\\":\\"我是一个聊天机器人。\\"}', 'maxLength' => 2048, 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'NluAccessProfile' => [
'description' => 'The configuration for a third-party conversation model.',
'type' => 'object',
'properties' => [
'AccessProfileId' => ['description' => 'The ID of the third-party conversation model configuration.', 'type' => 'string', 'required' => false, 'example' => 'c2c9baae-9351-4c49-a8cb-6f24a83a8718', 'maxLength' => 64, 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'OmniModel' => ['description' => 'Indicates whether the model is an Omni model.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
'NluAccessType' => [
'description' => 'The conversation model invocation method.',
'type' => 'string',
'required' => false,
'example' => 'MANAGED',
'maxLength' => 32,
'enum' => ['MANAGED', 'PROVIDED', 'AUTHORIZED'],
'title' => '',
],
],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'InteractionConfig',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => 'The interaction configuration.',
'type' => 'object',
'properties' => [
'SilenceDetectionConfig' => [
'description' => 'The silence detection configuration.',
'type' => 'object',
'properties' => [
'Timeout' => ['title' => 'Silence timeout duration, in milliseconds. When the User remains silent longer than the specified value, the system plays the silence timeout prompt. Range: 2000 to 10000.', 'description' => 'The silence timeout in milliseconds. If a user is silent for longer than this duration, a timeout message is played.
'."\n"
.'Range: 2,000 to 10,000.
', 'type' => 'integer', 'format' => 'int32', 'default' => '5000', 'required' => false, 'maximum' => '10000', 'minimum' => '2000', 'example' => '5000'],
'MaxRepeats' => ['description' => 'The maximum number of consecutive silent rounds before the system hangs up the call.
'."\n"
.'This parameter takes effect only when `NluEngine` is set to `PROMPTS`.
', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'EndConversationConfig' => [
'description' => 'The conversation-end configuration.',
'type' => 'object',
'properties' => [
'Delay' => ['title' => 'Execute hang-up action x seconds after the hang-up message finishes playing. The range is 0 to 5.', 'description' => 'The delay in seconds after the farewell message is played before the call ends. Range: 0 to 5.', 'type' => 'integer', 'format' => 'int32', 'default' => '0', 'required' => false, 'maximum' => '5', 'minimum' => '0', 'example' => '1'],
'Triggers' => [
'description' => 'The rules for automatically ending the conversation.',
'type' => 'array',
'items' => [
'description' => 'A rule for ending the conversation.',
'type' => 'object',
'properties' => [
'TriggerType' => [
'title' => 'TurnLimit: maximum number of interaction turns; '."\n"
.'IntelligentVoiceAssistant: intelligent voice assistant; '."\n"
.'InteractiveVoiceResponse: extension transfer; '."\n"
.'KeyWords: Custom blocking',
'description' => '`TurnLimit`: Ends the conversation when the number of conversation turns exceeds a specified limit.
'."\n"
.'`IntelligentVoiceAssistant`: Ends the conversation when the user invokes a voice assistant.
'."\n"
.'`InteractiveVoiceResponse`: Ends the conversation when the user requests an extension transfer.
'."\n"
.'`KeyWords`: Ends the conversation when a specified keyword is detected.
',
'type' => 'string',
'required' => false,
'example' => 'TurnLimit',
'enum' => ['TurnLimit', 'IntelligentVoiceAssistant', 'InteractiveVoiceResponse', 'KeyWords'],
],
'TurnLimit' => ['title' => 'When the number of interaction turns exceeds x, execute hang-up. The range is 0 to 100. A value of 0 means this feature is disabled.', 'description' => 'The maximum number of conversation turns before the call ends.'."\n"
.'Value range: 0 to 100.'."\n"
.'A value of 0 disables this feature.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'default' => '0', 'required' => false],
'ClosingStatement' => ['title' => 'The announcement played when the maximum number of turns is reached and the system executes a hang-up.', 'description' => 'The farewell message played when the call ends because the turn limit is reached.', 'type' => 'string', 'example' => '感谢您的接听，祝您生活愉快，再见!', 'required' => false, 'maxLength' => 128],
'KeyWords' => [
'description' => 'Keywords that trigger the end of the conversation.',
'title' => 'Custom block keywords',
'type' => 'array',
'items' => ['description' => 'A keyword that triggers the end of the conversation.', 'type' => 'string', 'required' => false, 'example' => '机器人助理', 'title' => ''],
'required' => false,
'example' => '',
],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'title' => '',
'example' => '',
],
],
'required' => false,
'title' => '',
'example' => '',
],
'InitialGreetingDelayMilliseconds' => ['description' => 'The delay in milliseconds after a call connects before the initial greeting is played.', 'type' => 'integer', 'format' => 'int32', 'default' => '0', 'required' => false, 'maximum' => '5000', 'minimum' => '0', 'example' => '2000', 'title' => ''],
'BackgroundMusicId' => ['description' => 'The ID of the background music.', 'type' => 'string', 'required' => false, 'example' => 'office-ambience', 'maxLength' => 64, 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'LabelConfig',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => 'The custom label configuration.',
'type' => 'array',
'items' => [
'description' => 'A custom label.',
'type' => 'object',
'properties' => [
'Name' => ['description' => 'The label name.', 'type' => 'string', 'required' => false, 'example' => '是否同意还款', 'maxLength' => 32, 'title' => ''],
'Description' => ['description' => 'The label description.', 'type' => 'string', 'required' => false, 'example' => '用户是否同意于还款截止日期前还款', 'maxLength' => 128, 'title' => ''],
'CandidateValues' => [
'description' => 'Candidate values for the label.',
'type' => 'array',
'items' => ['description' => 'A candidate value for the label.', 'type' => 'string', 'maxLength' => 32, 'required' => false, 'example' => '同意', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response data.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C00486CA-8025-5ED8-9AA5-E0AFBA87A098', 'title' => ''],
'Data' => ['description' => 'The version ID.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66b', 'title' => ''],
'Params' => [
'description' => 'A list of dynamic parameters for the error.',
'type' => 'array',
'items' => ['description' => 'A dynamic parameter for the error.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Create scenario version ',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"RequestId\\": \\"C00486CA-8025-5ED8-9AA5-E0AFBA87A098\\",\\n \\"Data\\": \\"af81a389-91f0-4157-8d82-720edd02b66b\\",\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'voicebot:CreateScriptVersion',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'CreateVariable' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '5daac920-d6c1-429f-a95f-2a798f5255b5', 'title' => ''],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => 'The name of the variable.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'userType', 'title' => ''],
],
[
'name' => 'DisplayName',
'in' => 'formData',
'schema' => ['description' => 'The display name of the variable.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '用户类型', 'title' => ''],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['description' => 'The description of the variable.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '表示用户类型，包括VIP、普通用户', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response schema.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ED56B723-5802-5C32-865F-6E20B06D2455'],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Data' => ['description' => 'The variable ID.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66b', 'title' => ''],
'Params' => [
'description' => 'The list of dynamic error parameters.',
'type' => 'array',
'items' => ['description' => 'A dynamic error parameter.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Create variable ',
'summary' => 'Creates a variable.',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ED56B723-5802-5C32-865F-6E20B06D2455\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": \\"af81a389-91f0-4157-8d82-720edd02b66b\\",\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'voicebot:CreateVariable',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'CreateVocabulary' => [
'summary' => 'Creates a hotword list.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'e48e45dd-e47a-4744-a063-f08cbebb1c5a', 'title' => ''],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => 'The name of the hotword list.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '金融行业热词', 'title' => ''],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['description' => 'A description of the hotword list.', 'type' => 'string', 'required' => false, 'example' => '包含金融行业专业术语', 'title' => ''],
],
[
'name' => 'Words',
'in' => 'formData',
'style' => 'json',
'schema' => [
'docRequired' => true,
'description' => 'The hotword list.',
'additionalProperties' => ['description' => 'A key-value pair where the key is the hotword and the value is its weight.', 'type' => 'string', 'example' => '{"苹果":"2","香蕉":"3"}', 'title' => ''],
'type' => 'object',
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response schema.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'BA2B89BE-BF85-5333-8A52-6D9F18A100F1'],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Data' => ['description' => 'The ID of the hotword list.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66b', 'title' => ''],
'Params' => [
'description' => 'A list of dynamic error parameters.',
'type' => 'array',
'items' => ['description' => 'The dynamic error parameter.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Create a hotword ',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BA2B89BE-BF85-5333-8A52-6D9F18A100F1\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": \\"af81a389-91f0-4157-8d82-720edd02b66b\\",\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'voicebot:CreateVocabulary',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'CreateVoiceAccessProfile' => [
'summary' => 'Creates a voice access profile.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
],
[
'name' => 'NlsEngine',
'in' => 'formData',
'schema' => [
'description' => 'The voice engine.',
'enumValueTitles' => ['IFLYTEK' => 'iFLYTEK', 'VOLC' => 'Doubao', 'BAILIAN' => 'Model Studio'],
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'VOLC',
'title' => '',
],
],
[
'name' => 'Profile',
'in' => 'formData',
'style' => 'json',
'schema' => [
'docRequired' => true,
'description' => 'The parameter configuration.',
'type' => 'object',
'properties' => [
'AppKey' => ['description' => 'This parameter is required when `NlsEngine` is set to `VOLC`.', 'type' => 'string', 'maxLength' => 64, 'required' => false, 'example' => '2541370123', 'title' => ''],
'AccessKey' => ['description' => 'This parameter is required when `NlsEngine` is set to `VOLC`.', 'type' => 'string', 'maxLength' => 64, 'required' => false, 'example' => 'HwRnTXgwnQOlsj68URDS5_VMm4Wtapq9', 'title' => ''],
'AppId' => ['description' => 'This parameter is required when `NlsEngine` is set to `IFLYTEK`.', 'type' => 'string', 'maxLength' => 64, 'required' => false, 'example' => '5b123bfb', 'title' => ''],
'ApiKey' => ['description' => 'This parameter is required when `NlsEngine` is set to `BAILIAN` or `IFLYTEK`.', 'type' => 'string', 'maxLength' => 64, 'required' => false, 'example' => 'sk-12341e259b1049e8872b47981e545f78', 'title' => ''],
'ApiSecret' => ['description' => 'This parameter is required when `NlsEngine` is set to `IFLYTEK`.', 'type' => 'string', 'maxLength' => 64, 'required' => false, 'example' => 'c0358c6e51c1013b446fdeb21a3a1234', 'title' => ''],
'AsrAppKey' => ['description' => 'This parameter is not used.', 'type' => 'string', 'maxLength' => 64, 'required' => false, 'example' => '暂无使用', 'title' => ''],
'TtsApiKey' => ['description' => 'This parameter is not used.', 'type' => 'string', 'maxLength' => 64, 'required' => false, 'example' => '暂无使用', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response body.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7401D698-0AAC-5909-B68E-88C68805FFB8'],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Data' => ['description' => 'The configuration ID.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66b', 'title' => ''],
'Params' => [
'description' => 'A list of parameters that provide additional details about the error.',
'type' => 'array',
'items' => ['description' => 'A parameter that provides additional details about the error.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Create third-party voice configuration ',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7401D698-0AAC-5909-B68E-88C68805FFB8\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": \\"af81a389-91f0-4157-8d82-720edd02b66b\\",\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'voicebot:CreateVoiceAccessProfile',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DeleteCallCenterProvider' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'maxLength' => 64, 'example' => '36e9a4cd-a821-4f78-86fa-a9a4aefeea2e', 'title' => ''],
],
[
'name' => 'ProviderId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the call center provider to delete.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'xxxxxxxxx', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response object.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7401D698-0AAC-5909-B68E-88C68805FFB8'],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Data' => ['description' => 'The ID of the deleted call center provider.', 'type' => 'string', 'example' => 'xxxxxxxxx', 'title' => ''],
'Params' => [
'description' => 'The dynamic error parameters.',
'type' => 'array',
'items' => ['description' => 'A dynamic error parameter.', 'type' => 'string', 'example' => '[]', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Delete Manual Service Provider ',
'summary' => 'Deletes a specified call center provider.',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7401D698-0AAC-5909-B68E-88C68805FFB8\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": \\"xxxxxxxxx\\",\\n \\"Params\\": [\\n \\"[]\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:DeleteCallCenterProvider',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DeleteCloneVoice' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'e48e45dd-e47a-4744-a063-f08cbebb1c5a', 'title' => ''],
],
[
'name' => 'CloneVoiceId',
'in' => 'formData',
'schema' => ['description' => 'The clone voice ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'e48e45dd-e47a-4744-a063-f08cbebb1c5b', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response body.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD'],
'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'Data' => ['description' => 'The ID of the clone voice that was deleted.', 'type' => 'string', 'example' => 'e48e45dd-e47a-4744-a063-f08cbebb1c5b', 'title' => ''],
'Params' => [
'description' => 'A list of dynamic error parameters.',
'type' => 'array',
'items' => ['description' => 'A dynamic error parameter.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Delete clone voice ',
'summary' => 'Deletes a clone voice.',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\",\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"Data\\": \\"e48e45dd-e47a-4744-a063-f08cbebb1c5b\\",\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'voicebot:DeleteCloneVoice',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DeleteInstruction' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'maxLength' => 64, 'example' => '36e9a4cd-a821-4f78-86fa-a9a4aefeea2e', 'title' => ''],
],
[
'name' => 'Code',
'in' => 'formData',
'schema' => ['description' => 'The instruction code.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'Transfer00', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response object.',
'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC'],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''],
'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Data' => ['description' => 'The instruction code.', 'type' => 'string', 'example' => 'Transfer00', 'title' => ''],
'Params' => [
'description' => 'The list of parameters.',
'type' => 'array',
'items' => ['description' => 'A parameter.', 'type' => 'string', 'example' => '36e9a4cd-a821-4f78-86fa-a9a4aefeea2e', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Delete Instruction',
'summary' => 'Deletes a global instruction for a Digital Employee.',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": \\"Transfer00\\",\\n \\"Params\\": [\\n \\"36e9a4cd-a821-4f78-86fa-a9a4aefeea2e\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:DeleteInstruction',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DeleteLlmAccessProfile' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
],
[
'name' => 'AccessProfileId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the access profile to delete.', 'type' => 'string', 'required' => false, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66b', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response object.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9DB8BA95-4513-54B9-9C67-A28909CFB4AD'],
'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'Data' => ['description' => 'The ID of the deleted access profile.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66b', 'title' => ''],
'Params' => [
'description' => 'A list of dynamic error parameters.',
'type' => 'array',
'items' => ['description' => 'A dynamic error parameter.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Delete third-party model configuration ',
'summary' => 'Deletes an LLM access profile.',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9DB8BA95-4513-54B9-9C67-A28909CFB4AD\\",\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"Data\\": \\"af81a389-91f0-4157-8d82-720edd02b66b\\",\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'voicebot:DeleteLlmAccessProfile',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DeleteScript' => [
'summary' => 'Deletes the specified script.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the script to delete.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '64241e64-190c-45d1-af66-06f51c07b090', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response schema.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request ', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'D24E0148-6D40-550E-9471-B2C5A34C3D12'],
'Code' => ['description' => 'The result code of the operation.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'Data' => ['description' => 'The script ID.', 'type' => 'string', 'example' => '64241e64-190c-45d1-af66-06f51c07b090', 'title' => ''],
'Params' => [
'description' => 'Parameters that provide context for an error.',
'type' => 'array',
'items' => ['description' => 'An error parameter.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Delete scenario ',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D24E0148-6D40-550E-9471-B2C5A34C3D12\\",\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"Data\\": \\"64241e64-190c-45d1-af66-06f51c07b090\\",\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'voicebot:DeleteScript',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DeleteVariable' => [
'summary' => 'Deletes a variable.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '0099b75d-60fd-4c63-8541-7fbba0ae6bb0', 'title' => ''],
],
[
'name' => 'VariableId',
'in' => 'formData',
'schema' => ['description' => 'The variable ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '0099b75d-60fd-4c63-8541-7fbba0ae6bb1', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response schema.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7401D698-0AAC-5909-B68E-88C68805FFB8'],
'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'Data' => ['description' => 'The ID of the deleted variable.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66b', 'title' => ''],
'Params' => [
'description' => 'A list of dynamic error parameters.',
'type' => 'array',
'items' => ['description' => 'A dynamic error parameter.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Delete variable ',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7401D698-0AAC-5909-B68E-88C68805FFB8\\",\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"Data\\": \\"af81a389-91f0-4157-8d82-720edd02b66b\\",\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'voicebot:DeleteVariable',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DeleteVocabulary' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the Voice Navigator instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
],
[
'name' => 'VocabularyId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the vocabulary to delete.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66b', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response body.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => '29D8CB48-2384-59C4-9618-3824009635C2'],
'Code' => ['description' => 'The error code. A value of `OK` indicates the request succeeded.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'Data' => ['description' => 'The ID of the deleted vocabulary.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66b', 'title' => ''],
'Params' => [
'description' => 'A list of dynamic error parameters.',
'type' => 'array',
'items' => ['description' => 'The dynamic error parameter.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Delete hotword ',
'summary' => 'Deletes a vocabulary from a Voice Navigator instance.',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"29D8CB48-2384-59C4-9618-3824009635C2\\",\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"Data\\": \\"af81a389-91f0-4157-8d82-720edd02b66b\\",\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'voicebot:DeleteVocabulary',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DeleteVoiceAccessProfile' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
],
[
'name' => 'AccessProfileId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the access profile.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66b', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response object.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => '97E7ED13-6884-52D7-B97E-C780D7870680'],
'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'Data' => ['description' => 'The ID of the access profile.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66b', 'title' => ''],
'Params' => [
'description' => 'The list of dynamic error parameters.',
'type' => 'array',
'items' => ['description' => 'A dynamic error parameter.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Delete third-party voice configuration ',
'summary' => 'Deletes a Voice Access Profile.',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"97E7ED13-6884-52D7-B97E-C780D7870680\\",\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"Data\\": \\"af81a389-91f0-4157-8d82-720edd02b66b\\",\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'voicebot:DeleteVoiceAccessProfile',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'Dialogue' => [
'methods' => ['post'],
'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => 'Instance ID '."\n", 'description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'maxLength' => 64, 'example' => '36e9a4cd-a821-4f78-86fa-a9a4aefeea2e'],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['title' => 'Scenario ID '."\n", 'description' => 'The script ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '0a88e269-01f5-49ac-97af-5830f0ccb271'],
],
[
'name' => 'SessionId',
'in' => 'query',
'schema' => ['title' => 'Session ID ', 'description' => 'The session ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '07d72ea0-6e38-48d4-8371-14deaaba996f'],
],
[
'name' => 'Extras',
'in' => 'query',
'schema' => ['title' => 'Extra parameters. '."\n"
.'For example, silence timeout: [{"dataType":"Silence"}] ', 'description' => 'Extras.'."\n"
.'For example, a silence timeout: \\[{"dataType":"Silence"}]'."\n"
.'>Valid values for `dataType`: `DTMF`, `Silence`, or `RuntimePrompts`.>'."\n"
."\n"
.'> - If `dataType` is `DTMF`, use the format: `[{"dataType":"DTMF","dtmf":"xxxx"}]`'."\n"
.'>'."\n"
.'> - If `dataType` is `Silence`, use the format: `[{"dataType":"Silence"}]`'."\n"
.'>'."\n"
.'> - If `dataType` is `RuntimePrompts`, use the format: `[{"dataType":"RuntimePrompts","prompts":"xxxx","persistent":false/true}]`', 'type' => 'string', 'required' => false, 'example' => '[{'."\n"
.' "dataType": "Silence"'."\n"
.'}]'],
],
[
'name' => 'Utterance',
'in' => 'query',
'schema' => ['title' => 'User response content '."\n", 'description' => 'The user\'s input for the conversational turn.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '行吧，那我就不打扰您了，再见。'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response body.',
'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'POP request ID', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9DB8BA95-4513-54B9-9C67-A28909CFB4AD'],
'HttpStatusCode' => ['title' => 'HTTP status code. A value of 200 indicates that the HTTP request succeeded.', 'description' => 'The HTTP status code. A value of `200` indicates a successful response.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['title' => 'HTTP response message', 'description' => 'The HTTP response message.', 'type' => 'string', 'example' => 'SUCCESS'],
'Code' => ['title' => 'Business status code. OK indicates that the request succeeded. '."\n", 'description' => 'The business status code. A value of `OK` indicates that the operation was successful.', 'type' => 'string', 'example' => 'OK'],
'Data' => [
'description' => 'The business-specific data returned by the operation.',
'title' => 'Business Data',
'type' => 'object',
'properties' => [
'Answer' => ['title' => 'Bot reply content', 'description' => 'The bot\'s reply.', 'type' => 'string', 'example' => '不好意思，我没听'],
'StreamEnd' => ['title' => 'Indicates whether the stream response has ended '."\n", 'description' => 'A flag that indicates whether the stream has ended. A value of `true` signifies the end of the stream.', 'type' => 'boolean', 'example' => 'true'],
'SessionId' => ['title' => 'Session ID '."\n", 'description' => 'The session ID.', 'type' => 'string', 'example' => '07d72ea0-6e38-48d4-8371-14deaaba996f'],
'StreamId' => ['title' => 'Turn ID of the conversation', 'description' => 'The stream ID for the conversational turn.', 'type' => 'string', 'example' => '1'],
'StartTime' => ['title' => 'Update Time '."\n", 'description' => 'The Unix timestamp for when the operation started.', 'type' => 'integer', 'format' => 'int64', 'example' => '1774858849987'],
'EndTime' => ['description' => 'The Unix timestamp for when the operation ended.', 'type' => 'integer', 'format' => 'int64', 'example' => '1752283603978', 'title' => ''],
'ControlParamsList' => [
'description' => 'A list of control parameters.',
'type' => 'array',
'items' => [
'description' => 'An object representing a single control parameter.',
'type' => 'object',
'properties' => [
'Type' => ['title' => 'Control parameter type, enumeration values: '."\n"
.'HangUp: Hang up '."\n"
.'Transfer: Transfer '."\n"
.'GatherDtmf: Collect DTMF input '."\n"
.'Voice: Voice '."\n", 'description' => 'The type of the control parameter.'."\n"
."\n"
.'> - `HangUp`: Hang up.'."\n"
.'>'."\n"
.'> - `Transfer`: Transfer.'."\n"
.'>'."\n"
.'> - `GatherDtmf`: Gather DTMF.'."\n"
.'>'."\n"
.'> - `Voice`: Voice.', 'type' => 'string', 'example' => 'Voice'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
'Params' => [
'description' => 'The parameters associated with an error.',
'type' => 'array',
'items' => ['description' => 'A dynamic error parameter.', 'type' => 'string', 'example' => '-', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Conversation '."\n",
'summary' => 'Process a single conversational turn.',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9DB8BA95-4513-54B9-9C67-A28909CFB4AD\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Answer\\": \\"不好意思，我没听\\",\\n \\"StreamEnd\\": true,\\n \\"SessionId\\": \\"07d72ea0-6e38-48d4-8371-14deaaba996f\\",\\n \\"StreamId\\": \\"1\\",\\n \\"StartTime\\": 1774858849987,\\n \\"EndTime\\": 1752283603978,\\n \\"ControlParamsList\\": [\\n {\\n \\"Type\\": \\"Voice\\"\\n }\\n ]\\n },\\n \\"Params\\": [\\n \\"-\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'voicebot:Dialogue',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DisableSubscription' => [
'summary' => 'Disables the subscription for a Voice Navigator instance.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The returned data.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD'],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Data' => ['description' => 'This parameter is not used.', 'type' => 'string', 'example' => '暂无使用', 'title' => ''],
'Params' => [
'description' => 'A list of dynamic error parameters.',
'type' => 'array',
'items' => ['description' => 'The dynamic error parameter.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Shutdown message subscription ',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": \\"暂无使用\\",\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:DisableSubscription',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'EndSession' => [
'summary' => 'Ends a session.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => 'Instance ID', 'description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'maxLength' => 64, 'example' => '36e9a4cd-a821-4f78-86fa-a9a4aefeea2e'],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['title' => 'Scenario ID', 'description' => 'The ID of the script.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '0a88e269-01f5-49ac-97af-5830f0ccb271'],
],
[
'name' => 'SessionId',
'in' => 'query',
'schema' => ['title' => 'Conversation ID', 'description' => 'The ID of the session.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '07d72ea0-6e38-48d4-8371-14deaaba996f'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The data returned.',
'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'POP request ID', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9DB8BA95-4513-54B9-9C67-A28909CFB4AD'],
'HttpStatusCode' => ['title' => 'HTTP status code. A value of 200 indicates that the HTTP request succeeded.', 'description' => 'The HTTP status code. A value of 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['title' => 'HTTP response message', 'description' => 'The HTTP response message.', 'type' => 'string', 'example' => 'SUCCESS'],
'Code' => ['title' => 'Business status code. A value of OK indicates that the request succeeded.', 'description' => 'The business status code. A value of OK indicates that the operation was successful.', 'type' => 'string', 'example' => 'OK'],
'Params' => [
'description' => 'The dynamic error parameters.',
'type' => 'array',
'items' => ['description' => 'A dynamic error parameter.', 'type' => 'string', 'example' => '-', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'End the conversation',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9DB8BA95-4513-54B9-9C67-A28909CFB4AD\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Code\\": \\"OK\\",\\n \\"Params\\": [\\n \\"-\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:EndSession',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ExportScript' => [
'summary' => 'Exports a specified script.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'c28fc549-d88f-4f6e-85ad-a0806e5e39c0', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the script.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '64241e64-190c-45d1-af66-06f51c07b090', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The returned data.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The error code. A value of `OK` indicates a successful request.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '83C6DA11-798F-5524-AB1D-555263E7A400', 'title' => ''],
'Data' => ['description' => 'The script ID.', 'type' => 'string', 'example' => '64241e64-190c-45d1-af66-06f51c07b090', 'title' => ''],
'Params' => [
'description' => 'The dynamic parameters for the error message.',
'type' => 'array',
'items' => ['description' => 'The dynamic error parameter.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Export scenario ',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"RequestId\\": \\"83C6DA11-798F-5524-AB1D-555263E7A400\\",\\n \\"Data\\": \\"64241e64-190c-45d1-af66-06f51c07b090\\",\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:ExportScript',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ExportVocabulary' => [
'summary' => 'Exports vocabularies.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the Voice Navigator instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
],
[
'name' => 'VocabularyIds',
'in' => 'formData',
'style' => 'json',
'schema' => [
'docRequired' => true,
'description' => 'The IDs of the vocabularies to export.',
'type' => 'array',
'items' => ['description' => 'The ID of the vocabulary.', 'type' => 'string', 'required' => false, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66b', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Response schema',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7401D698-0AAC-5909-B68E-88C68805FFB8'],
'Code' => ['description' => 'The internal error code. A value of `OK` indicates that the request was successful.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'Data' => ['description' => 'This parameter is reserved. You can ignore it.', 'type' => 'string', 'example' => '请忽略', 'title' => ''],
'Params' => [
'description' => 'A list of dynamic error parameters.',
'type' => 'array',
'items' => ['description' => 'A dynamic error parameter.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Export hotwords ',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7401D698-0AAC-5909-B68E-88C68805FFB8\\",\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"Data\\": \\"请忽略\\",\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:ExportVocabulary',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'GenerateFileUploadParams' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
],
[
'name' => 'FileName',
'in' => 'formData',
'schema' => ['description' => 'The file name.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'test.wav', 'title' => ''],
],
[
'name' => 'BusinessType',
'in' => 'formData',
'schema' => [
'description' => 'The file type.',
'enumValueTitles' => ['Vocabulary' => 'A vocabulary file.', 'CloneVoice' => 'A cloned voice file.'],
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'CloneVoice',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response schema.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F132DDBA-66C4-5BD3-BF7E-9642FE877158', 'title' => ''],
'Data' => [
'description' => 'The parameters for uploading the file.',
'type' => 'object',
'properties' => [
'Signature' => ['description' => 'The signature calculated from the **AccessKey Secret** and **policy**. OSS uses this signature to authenticate the request.', 'type' => 'string', 'example' => '6oETypl+gbYHwbgcwnQiyDYoQbA=', 'title' => ''],
'Policy' => ['description' => 'The policy used to validate the request form fields.', 'type' => 'string', 'example' => 'eyJleHBpcmF0aW9uIjoiMjAyNi0wMy0yOVQxMzoyNDoyNi4yMDNaIiwiY29uZGl0aW9ucyI6W239', 'title' => ''],
'AccessKeyId' => ['description' => 'The AccessKey ID used to generate the signature.', 'type' => 'string', 'example' => 'STS.NYGg9ejEjYqySx3EsuRutagbd', 'title' => ''],
'Host' => ['description' => 'The OSS endpoint.', 'type' => 'string', 'example' => 'http://cab.oss-cn-hangzhou.aliyuncs.com', 'title' => ''],
'FileKey' => ['description' => 'The object key for the uploaded file.', 'type' => 'string', 'example' => 'vocabulary/B678CA67-C8CB-150C-AD7F-6FA7F0A811BA_热词导入模版 (7).zip', 'title' => ''],
'ExpirationTime' => ['description' => 'The expiration time of the upload credentials.', 'type' => 'integer', 'format' => 'int64', 'example' => '1774794266093', 'title' => ''],
'SecurityToken' => ['description' => 'The security token.', 'type' => 'string', 'example' => 'CAISzwJ1q6Ft5B2yfSjIr5ryLIjRh5pL7rOSUV6CoXMgXvpYjqLJhjz2IHhMfnlvB+gYsfU2m2xR5/Yclrp6SJtIXleCZtF94oxN9h2gb4fb42Jqag+/08/LI3OaLjKm9u2wCryLYbGwU/OpbE++5U0X6LDmdDKkckW4OJmS8/BOZcgWWQ/KBlgvRq0hRG1YpdQdKGHaONu0LxfumRCwNkdzvRdmgm4NgsbWgO/ks0GG3ASmlrFF+9mufMb5M/MBZskvD42Hu8VtbbfE3SJq7BxHybx7lqQs+02c5onHUwYPu0vZYrOLroQ+fFFjHKMzDdtPq/7ylPI9ofDamIXxxAarin3kufQeLmrJ4LwneIvBXr5RHd5wa2rbWAEsmLNBEhL2EJMKtT476hcbIAuUI3bC5F+kxOHp9i6ErImtRWbLssUUla4R5TGOWbLJWzkTH93xuRqAAapuIRuRt0d2Odr1hsaYukMd42UkNapdTrehzmXeR6lyv1jlLmkAHve9Cbl9N5bO3A96FSlEfjHksQBWG0CEXRm3jLW41bpR00dgnM6gpOj7lRW2z33L0dTtaRw79X3+Uqz3gv9md5QvoaVi1jnr/cFRNxbjl7DI39pdcGlTI2lqIAA=', 'title' => ''],
'AccessKeySecret' => ['description' => 'The AccessKey Secret used to authorize the OSS file upload.', 'type' => 'string', 'example' => 'DGhwedF4SsbsqUMfzNBCjZFLJZSAdhiSE4hFPbKMm6JE', 'title' => ''],
'Bucket' => ['description' => 'The name of the OSS bucket.', 'type' => 'string', 'example' => 'cab', 'title' => ''],
'Region' => ['description' => 'The region.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
],
'title' => '',
'example' => '',
],
'Params' => [
'description' => 'A list of parameters for the error message.',
'type' => 'array',
'items' => ['description' => 'An error message parameter.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Obtain file upload parameters ',
'summary' => 'Generates temporary credentials and parameters to upload a file to Object Storage Service (OSS).',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"RequestId\\": \\"F132DDBA-66C4-5BD3-BF7E-9642FE877158\\",\\n \\"Data\\": {\\n \\"Signature\\": \\"6oETypl+gbYHwbgcwnQiyDYoQbA=\\",\\n \\"Policy\\": \\"eyJleHBpcmF0aW9uIjoiMjAyNi0wMy0yOVQxMzoyNDoyNi4yMDNaIiwiY29uZGl0aW9ucyI6W239\\",\\n \\"AccessKeyId\\": \\"STS.NYGg9ejEjYqySx3EsuRutagbd\\",\\n \\"Host\\": \\"http://cab.oss-cn-hangzhou.aliyuncs.com\\",\\n \\"FileKey\\": \\"vocabulary/B678CA67-C8CB-150C-AD7F-6FA7F0A811BA_热词导入模版 (7).zip\\",\\n \\"ExpirationTime\\": 1774794266093,\\n \\"SecurityToken\\": \\"CAISzwJ1q6Ft5B2yfSjIr5ryLIjRh5pL7rOSUV6CoXMgXvpYjqLJhjz2IHhMfnlvB+gYsfU2m2xR5/Yclrp6SJtIXleCZtF94oxN9h2gb4fb42Jqag+/08/LI3OaLjKm9u2wCryLYbGwU/OpbE++5U0X6LDmdDKkckW4OJmS8/BOZcgWWQ/KBlgvRq0hRG1YpdQdKGHaONu0LxfumRCwNkdzvRdmgm4NgsbWgO/ks0GG3ASmlrFF+9mufMb5M/MBZskvD42Hu8VtbbfE3SJq7BxHybx7lqQs+02c5onHUwYPu0vZYrOLroQ+fFFjHKMzDdtPq/7ylPI9ofDamIXxxAarin3kufQeLmrJ4LwneIvBXr5RHd5wa2rbWAEsmLNBEhL2EJMKtT476hcbIAuUI3bC5F+kxOHp9i6ErImtRWbLssUUla4R5TGOWbLJWzkTH93xuRqAAapuIRuRt0d2Odr1hsaYukMd42UkNapdTrehzmXeR6lyv1jlLmkAHve9Cbl9N5bO3A96FSlEfjHksQBWG0CEXRm3jLW41bpR00dgnM6gpOj7lRW2z33L0dTtaRw79X3+Uqz3gv9md5QvoaVi1jnr/cFRNxbjl7DI39pdcGlTI2lqIAA=\\",\\n \\"AccessKeySecret\\": \\"DGhwedF4SsbsqUMfzNBCjZFLJZSAdhiSE4hFPbKMm6JE\\",\\n \\"Bucket\\": \\"cab\\",\\n \\"Region\\": \\"cn-hangzhou\\"\\n },\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:GenerateFileUploadParams',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'GetCallDetailRecord' => [
'summary' => 'Get call details.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'c28fc549-d88f-4f6e-85ad-a0806e5e39c0', 'title' => ''],
],
[
'name' => 'SessionId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the session.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '9fe19f64-a290-4a73-a3ed-5f7d21d44ecb', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'a2c26e67-5984-4935-984e-bcee52971993'],
'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''],
'Data' => [
'type' => 'object',
'properties' => [
'SessionId' => ['description' => 'The session ID.', 'type' => 'string', 'example' => '07d72ea0-6e38-48d4-8371-14deaaba996f', 'title' => ''],
'StartTime' => ['description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1774858849987', 'title' => ''],
'EndTime' => ['description' => 'The end time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1752283603978', 'title' => ''],
'Caller' => ['description' => 'The phone number of the caller.', 'type' => 'string', 'example' => '15929990193', 'title' => ''],
'Callee' => ['description' => 'The phone number of the callee.', 'type' => 'string', 'example' => '15100000001', 'title' => ''],
'DispositionCode' => [
'description' => 'The disposition code for the call.',
'type' => 'string',
'enumValueTitles' => ['Rejected' => '拒接', 'Answered' => '已接通'],
'example' => 'Answered',
'title' => '',
],
'DispositionReason' => [
'description' => 'The reason for the call\'s disposition.',
'type' => 'string',
'enumValueTitles' => ['ConcurrentLimitExceeded' => '并发超限', 'SilenceTimeout' => '静默超时', 'TurnsLimitExceeded' => '对话轮次超限', 'Transferred' => '已转接', 'Normal' => '正常挂机', 'Exception' => '系统异常'],
'example' => 'ConcurrentLimitExceeded',
'title' => '',
],
'ReleaseInitiator' => [
'description' => 'The party that ended the call.',
'type' => 'string',
'enumValueTitles' => ['Customer' => '客户', 'Assistant' => '机器人'],
'example' => 'Customer',
'title' => '',
],
'TransferType' => [
'description' => 'The transfer type.',
'type' => 'string',
'enumValueTitles' => ['SkillGroup' => '技能组', 'Agent' => '坐席', 'External' => '外部电话'],
'example' => 'SkillGroup',
'title' => '',
],
'TransferTarget' => ['description' => 'The transfer target.', 'type' => 'string', 'example' => 'default@testInstance1', 'title' => ''],
'TalkTurns' => ['description' => 'The number of conversation turns.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
'TalkTime' => ['description' => 'The talk time, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'Duration' => ['description' => 'The session duration, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '160', 'title' => ''],
'Transcripts' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'StreamId' => ['description' => 'The ID of the conversation turn.', 'type' => 'string', 'example' => '1', 'title' => ''],
'EventTime' => ['description' => 'The event timestamp, in milliseconds since the Unix epoch.', 'type' => 'string', 'example' => '1774859592165', 'title' => ''],
'Role' => [
'description' => 'The role of the speaker.',
'type' => 'string',
'enumValueTitles' => ['USER' => '客户', 'ASSISTANT' => '机器人'],
'example' => 'USER',
'title' => '',
],
'Utterance' => ['description' => 'The user\'s utterance. This parameter is valid when `Role` is `USER`.', 'type' => 'string', 'example' => '你要说你快点说不说，我挂了哈。', 'title' => ''],
'Answer' => ['description' => 'The bot\'s response. This parameter is valid when `Role` is `ASSISTANT`.', 'type' => 'string', 'example' => '不好意思，', 'title' => ''],
'PlayedWords' => ['description' => 'The number of words played from the bot\'s response. This parameter is valid when `Role` is `USER`.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'VendorParams' => ['description' => 'Vendor-specific data sent from the client. This parameter is valid when `Role` is `USER`.', 'type' => 'string', 'example' => '{"test1":"1234"}', 'title' => ''],
'Extras' => ['description' => 'Additional input from the user other than speech. This parameter is valid when `Role` is `USER`.', 'type' => 'string', 'example' => '[{"dataType":"Silence"}]', 'title' => ''],
'ControlParamsList' => ['description' => 'A list of control parameters. This parameter is valid when `Role` is `ASSISTANT`.', 'type' => 'string', 'example' => '[{"endSilenceTimeout":500,"interruptible":false,"silenceDetectionTimeout":5,"type":"Voice"}]', 'title' => ''],
'StreamEnd' => ['description' => 'Indicates if this is the final part of a streamed response.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'BeginTime' => ['description' => 'The start timestamp of the turn, in milliseconds since the Unix epoch.', 'type' => 'integer', 'format' => 'int64', 'example' => '1748945414222', 'title' => ''],
'EndTime' => ['description' => 'The end timestamp of the turn, in milliseconds since the Unix epoch.', 'type' => 'integer', 'format' => 'int64', 'example' => '1767315903531', 'title' => ''],
'Backchannels' => ['description' => 'Indicates whether the user\'s utterance is a backchannel (for example, "uh-huh" or "okay"). This parameter is valid when `Role` is `USER`.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'Legacy' => ['description' => 'Indicates whether the bot\'s response is obsolete. This parameter is valid when `Role` is `ASSISTANT`.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'Interrupted' => ['description' => 'Indicates whether the turn was interrupted.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => 'The conversation transcripts.',
'title' => '',
'example' => '',
],
'IssueResolved' => ['description' => 'Indicates whether the user\'s issue was resolved.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'ResolutionEvidence' => ['description' => 'The basis for the resolution judgment.', 'type' => 'string', 'example' => 'unknown', 'title' => ''],
],
'description' => 'The call detail record.',
'title' => '',
'example' => '',
],
'Params' => [
'type' => 'array',
'items' => ['description' => 'A parameter related to the error.', 'type' => 'string', 'example' => '[\'zhenhyuantest\']', 'title' => ''],
'description' => 'A list of parameters related to the error.',
'title' => '',
'example' => '',
],
],
'description' => 'The schema of the response.',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'GetCallDetailRecord',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:GetCallDetailRecord',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"a2c26e67-5984-4935-984e-bcee52971993\\",\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Data\\": {\\n \\"SessionId\\": \\"07d72ea0-6e38-48d4-8371-14deaaba996f\\",\\n \\"StartTime\\": 1774858849987,\\n \\"EndTime\\": 1752283603978,\\n \\"Caller\\": \\"15929990193\\",\\n \\"Callee\\": \\"15100000001\\",\\n \\"DispositionCode\\": \\"Answered\\",\\n \\"DispositionReason\\": \\"ConcurrentLimitExceeded\\",\\n \\"ReleaseInitiator\\": \\"Customer\\",\\n \\"TransferType\\": \\"SkillGroup\\",\\n \\"TransferTarget\\": \\"default@testInstance1\\",\\n \\"TalkTurns\\": 5,\\n \\"TalkTime\\": 100,\\n \\"Duration\\": 160,\\n \\"Transcripts\\": [\\n {\\n \\"StreamId\\": \\"1\\",\\n \\"EventTime\\": \\"1774859592165\\",\\n \\"Role\\": \\"USER\\",\\n \\"Utterance\\": \\"你要说你快点说不说，我挂了哈。\\",\\n \\"Answer\\": \\"不好意思，\\",\\n \\"PlayedWords\\": 10,\\n \\"VendorParams\\": \\"{\\\\\\"test1\\\\\\":\\\\\\"1234\\\\\\"}\\",\\n \\"Extras\\": \\"[{\\\\\\"dataType\\\\\\":\\\\\\"Silence\\\\\\"}]\\",\\n \\"ControlParamsList\\": \\"[{\\\\\\"endSilenceTimeout\\\\\\":500,\\\\\\"interruptible\\\\\\":false,\\\\\\"silenceDetectionTimeout\\\\\\":5,\\\\\\"type\\\\\\":\\\\\\"Voice\\\\\\"}]\\",\\n \\"StreamEnd\\": true,\\n \\"BeginTime\\": 1748945414222,\\n \\"EndTime\\": 1767315903531,\\n \\"Backchannels\\": false,\\n \\"Legacy\\": false,\\n \\"Interrupted\\": false\\n }\\n ],\\n \\"IssueResolved\\": false,\\n \\"ResolutionEvidence\\": \\"unknown\\"\\n },\\n \\"Params\\": [\\n \\"[\'zhenhyuantest\']\\"\\n ]\\n}","type":"json"}]',
],
'GetDataChannelCredential' => [
'summary' => 'Retrieves a data channel credential.',
'methods' => ['post'],
'schemes' => ['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' => false, 'docRequired' => true, 'maxLength' => 64, 'example' => 'c28fc549-d88f-4f6e-85ad-a0806e5e39c0', 'title' => ''],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['description' => 'The device ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'd4c38420-****-43bc-b001-56bfc274****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of response',
'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A8AED3C8-F57B-5D71-9A34-4A170287533F'],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''],
'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Data' => [
'description' => 'The data channel credential.',
'type' => 'object',
'properties' => [
'DeviceId' => ['description' => 'The device ID.', 'type' => 'string', 'example' => 'd4c38420-****-43bc-b001-56bfc274****', 'title' => ''],
'Topic' => ['description' => 'The topic for the data channel.', 'type' => 'string', 'example' => 'datachannel-hz/****', 'title' => ''],
'ClientId' => ['description' => 'The client ID.', 'type' => 'string', 'example' => 'GID_rtc-datachannel@@@*******', 'title' => ''],
'Endpoint' => ['description' => 'The endpoint.', 'type' => 'string', 'example' => 'mqtt.***.aliyuncs.com', 'title' => ''],
'UserName' => ['description' => 'The username.', 'type' => 'string', 'example' => 'Token|LTAI****|mqtt-***', 'title' => ''],
'Password' => ['description' => 'The password.', 'type' => 'string', 'example' => '*********', 'title' => ''],
'ExpirationTime' => ['description' => 'The expiration time of the credential.', 'type' => 'integer', 'format' => 'int64', 'example' => '1774794266093', 'title' => ''],
],
'title' => '',
'example' => '',
],
'Params' => [
'description' => 'The dynamic error parameters.',
'type' => 'array',
'items' => ['description' => 'A dynamic error parameter.', 'type' => 'string', 'example' => '-', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Obtain tunnel Credential ',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A8AED3C8-F57B-5D71-9A34-4A170287533F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": {\\n \\"DeviceId\\": \\"d4c38420-****-43bc-b001-56bfc274****\\",\\n \\"Topic\\": \\"datachannel-hz/****\\",\\n \\"ClientId\\": \\"GID_rtc-datachannel@@@*******\\",\\n \\"Endpoint\\": \\"mqtt.***.aliyuncs.com\\",\\n \\"UserName\\": \\"Token|LTAI****|mqtt-***\\",\\n \\"Password\\": \\"*********\\",\\n \\"ExpirationTime\\": 1774794266093\\n },\\n \\"Params\\": [\\n \\"-\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:GetDataChannelCredential',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'GetInstanceTrendingReport' => [
'summary' => 'Retrieves the metric trends chart for an instance.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '82b2eaae-ce5c-45f8-8231-f15b6b27e55c', 'title' => ''],
],
[
'name' => 'StartTime',
'in' => 'formData',
'schema' => ['description' => 'The start time of the statistical period. The value is a millisecond-level UNIX timestamp that represents the number of milliseconds elapsed since 1970-01-01 00:00:00 UTC. The following constraints apply:'."\n"
.'1. Earliest boundary: The start time can trace back to 00:00:00 of the date 365 calendar days before the current date.'."\n"
.'2. Time granularity alignment: For hourly queries, the minutes, seconds, and milliseconds must be 0. For daily queries, the hours, minutes, seconds, and milliseconds must be 0.'."\n"
.'3. If the specified timestamp is not aligned with the corresponding granularity, the server automatically rounds it up.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '1582267398628', 'title' => ''],
],
[
'name' => 'EndTime',
'in' => 'formData',
'schema' => ['description' => 'The end time of the statistical period. The value is a millisecond-level UNIX timestamp that represents the number of milliseconds elapsed since 1970-01-01 00:00:00 UTC. The following constraints apply:'."\n"
."\n"
.'Time range constraint: The maximum time range is 7 days for hourly queries and 180 days for daily queries.'."\n"
.'Time granularity alignment: For hourly queries, the minutes, seconds, and milliseconds must be 0. For daily queries, the hours, minutes, seconds, and milliseconds must be 0.'."\n"
.'If the specified timestamp is not aligned with the corresponding granularity, the server automatically rounds it up.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '1582103299434', 'title' => ''],
],
[
'name' => 'TimeInterval',
'in' => 'formData',
'schema' => ['description' => 'The time interval.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '1d', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD'],
'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'Data' => [
'description' => 'The scenario ID.',
'type' => 'array',
'items' => [
'description' => 'The statistics for a specific time interval.',
'type' => 'object',
'properties' => [
'StatsTime' => ['description' => 'The statistical time. The value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1774881208361', 'title' => ''],
'UsedConcurrency' => ['description' => 'The maximum concurrency used.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'ConfiguredConcurrency' => ['description' => 'The latest configured concurrency.', 'type' => 'integer', 'format' => 'int64', 'example' => '13', 'title' => ''],
'CallsOffered' => ['description' => 'The number of incoming sessions.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'CallsHandled' => ['description' => 'The number of answered sessions.', 'type' => 'integer', 'format' => 'int64', 'example' => '7', 'title' => ''],
'CallsRejected' => ['description' => 'The number of rejected sessions.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''],
'CallsResolved' => ['description' => 'The number of resolved sessions, based on the model evaluation results.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''],
'TotalInputTokens' => ['description' => 'Reserved for future use.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'TotalOutputTokens' => ['description' => 'Reserved for future use.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'TotalTokens' => ['description' => 'Reserved for future use.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'TotalTalkTime' => ['description' => 'The total talk time, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
'MaxTalkTime' => ['description' => 'The maximum talk time, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
'RejectionBreakdown' => ['description' => 'The distribution of rejection reasons.', 'type' => 'string', 'example' => '{'."\n"
.' "ConcurrentLimitExceeded":3'."\n"
.'}', 'title' => ''],
'ReleaseReasonBreakdown' => ['description' => 'The distribution of hang-up reasons after a session is connected.', 'type' => 'string', 'example' => '{'."\n"
.' "SilenceTimeout":1,'."\n"
.' "TurnsLimitExceeded":1,'."\n"
.' "Exception":1,'."\n"
.' "Transferred":1,'."\n"
.' "Normal":1'."\n"
.'}', 'title' => ''],
'LabelBreakdown' => ['description' => 'The distribution of labels.', 'type' => 'string', 'example' => '{'."\n"
.' "label1":{ '."\n"
.' "label1_sub1":10,'."\n"
.' "label1_sub2":2'."\n"
.'}'."\n"
.'}', 'title' => ''],
'TalkTurnsDistribution' => ['description' => 'The distribution of dialog turns.', 'type' => 'string', 'example' => '{'."\n"
.' "1":2,'."\n"
.' "10":3'."\n"
.'}', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'Params' => [
'description' => 'The dynamic error parameters.',
'type' => 'array',
'items' => ['description' => 'The list of error parameters.', 'type' => 'string', 'example' => '-', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Retrieve instance metric trends chart',
'description' => '## Operation description'."\n"
.'- This API operation is used to query the script configuration details for a specific scenario, including settings for ASR, TTS, and dialog capabilities.'."\n"
.'- No additional parameters are required in the request. The response contains configuration data for both the draft version and the published version.'."\n"
.'- Check the `Data` field in the response to obtain detailed configuration information.',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:GetInstanceTrendingReport',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\",\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"Data\\": [\\n {\\n \\"StatsTime\\": 1774881208361,\\n \\"UsedConcurrency\\": 10,\\n \\"ConfiguredConcurrency\\": 13,\\n \\"CallsOffered\\": 10,\\n \\"CallsHandled\\": 7,\\n \\"CallsRejected\\": 3,\\n \\"CallsResolved\\": 4,\\n \\"TotalInputTokens\\": 0,\\n \\"TotalOutputTokens\\": 0,\\n \\"TotalTokens\\": 0,\\n \\"TotalTalkTime\\": 100,\\n \\"MaxTalkTime\\": 20,\\n \\"RejectionBreakdown\\": \\"{\\\\n \\\\\\"ConcurrentLimitExceeded\\\\\\":3\\\\n}\\",\\n \\"ReleaseReasonBreakdown\\": \\"{\\\\n \\\\\\"SilenceTimeout\\\\\\":1,\\\\n \\\\\\"TurnsLimitExceeded\\\\\\":1,\\\\n \\\\\\"Exception\\\\\\":1,\\\\n \\\\\\"Transferred\\\\\\":1,\\\\n \\\\\\"Normal\\\\\\":1\\\\n}\\",\\n \\"LabelBreakdown\\": \\"{\\\\n \\\\\\"label1\\\\\\":{ \\\\n \\\\\\"label1_sub1\\\\\\":10,\\\\n \\\\\\"label1_sub2\\\\\\":2\\\\n}\\\\n}\\",\\n \\"TalkTurnsDistribution\\": \\"{\\\\n \\\\\\"1\\\\\\":2,\\\\n \\\\\\"10\\\\\\":3\\\\n}\\"\\n }\\n ],\\n \\"Params\\": [\\n \\"-\\"\\n ]\\n}","type":"json"}]',
],
'GetRealtimeInstanceStats' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '12f407b22cbe4890ac595f09985848d5', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response data.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'ID of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => '3a530dc0-7cfa-48f6-9539-bf9001e77b16'],
'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''],
'Data' => [
'description' => 'The real-time stats for the instance.',
'type' => 'object',
'properties' => [
'StatsTime' => ['description' => 'The time when the statistics were collected, expressed as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1774881208361', 'title' => ''],
'UsedConcurrency' => ['description' => 'The current number of concurrent tasks for the instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'ConfiguredConcurrency' => ['description' => 'The maximum number of concurrent tasks configured for the instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '13', 'title' => ''],
'RealtimeScriptStatsList' => [
'description' => 'A list of real-time stats for scripts.',
'type' => 'array',
'items' => [
'description' => 'The real-time stats for a script.',
'type' => 'object',
'properties' => [
'ScriptId' => ['description' => 'The script ID.', 'type' => 'string', 'example' => '92836ced-6f3a-4cec-bc3d-c3893d3c7efa', 'title' => ''],
'ScriptName' => ['description' => 'The script name.', 'type' => 'string', 'example' => 'TypeCombinationTest', 'title' => ''],
'StatsTime' => ['description' => 'The time when the statistics were collected, expressed as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1774881208361', 'title' => ''],
'UsedConcurrency' => ['description' => 'The current number of concurrent tasks for this script.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'ConfiguredConcurrency' => ['description' => 'The maximum number of concurrent tasks configured for this script.', 'type' => 'integer', 'format' => 'int32', 'example' => '13', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'Params' => [
'description' => 'A list of parameters that are related to an error, if one occurred.',
'type' => 'array',
'items' => ['description' => 'An error parameter.', 'type' => 'string', 'example' => '["123","345"]', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Retrieve real-time instance metrics',
'summary' => 'Retrieves real-time stats for an instance.',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3a530dc0-7cfa-48f6-9539-bf9001e77b16\\",\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Data\\": {\\n \\"StatsTime\\": 1774881208361,\\n \\"UsedConcurrency\\": 10,\\n \\"ConfiguredConcurrency\\": 13,\\n \\"RealtimeScriptStatsList\\": [\\n {\\n \\"ScriptId\\": \\"92836ced-6f3a-4cec-bc3d-c3893d3c7efa\\",\\n \\"ScriptName\\": \\"TypeCombinationTest\\",\\n \\"StatsTime\\": 1774881208361,\\n \\"UsedConcurrency\\": 10,\\n \\"ConfiguredConcurrency\\": 13\\n }\\n ]\\n },\\n \\"Params\\": [\\n \\"[\\\\\\"123\\\\\\",\\\\\\"345\\\\\\"]\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:GetRealtimeInstanceStats',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'GetRealtimeScriptStats' => [
'summary' => 'Queries the real-time statistics for a specified script.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cd6fc91bc13445c2af7f2e3e31418520', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'formData',
'schema' => ['description' => 'The script ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '64241e64-190c-45d1-af66-06f51c07b090', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response object.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'ID of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'd74d6290-7cbe-4436-b5d7-014ebb0f4060'],
'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''],
'Data' => [
'description' => 'The real-time script statistics.',
'type' => 'object',
'properties' => [
'StatsTime' => ['description' => 'The time the statistics were collected, expressed as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1774881658931', 'title' => ''],
'UsedConcurrency' => ['description' => 'The current concurrency.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'ConfiguredConcurrency' => ['description' => 'The configured concurrency.', 'type' => 'integer', 'format' => 'int32', 'example' => '13', 'title' => ''],
],
'title' => '',
'example' => '',
],
'Params' => [
'description' => 'A list of error parameters.',
'type' => 'array',
'items' => ['description' => 'An error parameter.', 'type' => 'string', 'example' => '["12345"]', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Query real-time statistics for a scenario ',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"d74d6290-7cbe-4436-b5d7-014ebb0f4060\\",\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Data\\": {\\n \\"StatsTime\\": 1774881658931,\\n \\"UsedConcurrency\\": 10,\\n \\"ConfiguredConcurrency\\": 13\\n },\\n \\"Params\\": [\\n \\"[\\\\\\"12345\\\\\\"]\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:GetRealtimeScriptStats',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'GetRecording' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '868eef14-7515-4856-8a50-5c9a22abdbcc', 'title' => ''],
],
[
'name' => 'SessionId',
'in' => 'formData',
'schema' => ['description' => 'The session ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '89ab28c2-eb94-4010-a539-f0eee922e371', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response object.',
'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'ID of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F132DDBA-66C4-5BD3-BF7E-9642FE877158'],
'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''],
'Data' => [
'description' => 'The recording object.',
'type' => 'object',
'properties' => [
'SessionId' => ['description' => 'The session ID.', 'type' => 'string', 'example' => 'f814f3ae-b2a7-44fb-883c-771221274673', 'title' => ''],
'FileName' => ['description' => 'The recording file name.', 'type' => 'string', 'example' => '61f7f225-3a2e-4b6e-8a1d-888f1862590f.wav', 'title' => ''],
'FileUrl' => ['description' => 'The recording file URL.', 'type' => 'string', 'example' => 'https://bgc-us-east.oss-accelerate.aliyuncs.com/intellidocs/2025-08-27/bc84ce11-f110-436d-af70-382ce7c5690a.pdf', 'title' => ''],
],
'title' => '',
'example' => '',
],
'Params' => [
'description' => 'The error parameter list.',
'type' => 'array',
'items' => ['description' => 'The error parameter.', 'type' => 'string', 'example' => '[\'ly-online\']', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Obtain Call Recording',
'summary' => 'Retrieves the download URL for a call recording.',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F132DDBA-66C4-5BD3-BF7E-9642FE877158\\",\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Data\\": {\\n \\"SessionId\\": \\"f814f3ae-b2a7-44fb-883c-771221274673\\",\\n \\"FileName\\": \\"61f7f225-3a2e-4b6e-8a1d-888f1862590f.wav\\",\\n \\"FileUrl\\": \\"https://bgc-us-east.oss-accelerate.aliyuncs.com/intellidocs/2025-08-27/bc84ce11-f110-436d-af70-382ce7c5690a.pdf\\"\\n },\\n \\"Params\\": [\\n \\"[\'ly-online\']\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:GetRecording',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'GetScript' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'Instance ID', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '8a503680-815d-473e-a9b0-e010f47a64d2', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'formData',
'schema' => ['description' => 'Scenario ID', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ac6db76a-bbe7-4a2c-b7cc-7f62da7bb4c6', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Code' => ['description' => 'Internal error code', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'HttpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'Error message', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '51E08AA9-8D1F-55F8-84A3-40635E2F0806', 'title' => ''],
'Data' => [
'description' => 'Scenario object information',
'type' => 'object',
'properties' => [
'ScriptId' => ['description' => 'Scenario ID', 'type' => 'string', 'example' => '64241e64-190c-45d1-af66-06f51c07b090', 'title' => ''],
'Name' => ['description' => 'Scenario name', 'type' => 'string', 'example' => '测试场景', 'title' => ''],
'Description' => ['description' => 'Description', 'type' => 'string', 'example' => 'test script', 'title' => ''],
'Concurrency' => ['description' => 'Concurrency', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'CreatedTime' => ['description' => 'Creation time', 'type' => 'integer', 'format' => 'int64', 'example' => '1773228988000', 'title' => ''],
'UpdatedTime' => ['description' => 'Update time', 'type' => 'integer', 'format' => 'int64', 'example' => '1773228988000', 'title' => ''],
'NluEngine' => [
'description' => 'Natural Language Understanding (NLU) engine',
'enumValueTitles' => ['PROMPTS' => 'PROMPTS', 'BEEBOT' => 'BEEBOT', 'FUNCTION' => 'FUNCTION'],
'type' => 'string',
'example' => 'BEEBOT',
'title' => '',
],
'Status' => [
'description' => 'Status',
'enumValueTitles' => ['PUBLISHED' => 'PUBLISHED', 'DRAFT' => 'DRAFT', 'PUBLISHED_DRAFT' => 'PUBLISHED\\_DRAFT'],
'type' => 'string',
'example' => 'DRAFT',
'title' => '',
],
'DraftVersion' => [
'description' => 'Draft version information',
'type' => 'object',
'properties' => [
'VersionId' => ['description' => 'Version ID', 'type' => 'string', 'example' => '0c4f978a-73bb-4841-bd84-75c0398edd4e', 'title' => ''],
'TranscriberConfig' => [
'description' => 'ASR configuration',
'type' => 'object',
'properties' => [
'NlsEngine' => [
'description' => 'ASR engine',
'enumValueTitles' => ['IFLYTEK' => 'IFLYTEK', 'VOLC' => 'VOLC', 'BAILIAN' => 'BAILIAN'],
'type' => 'string',
'example' => 'BAILIAN',
'title' => '',
],
'NlsAccessType' => [
'description' => 'ASR call method',
'enumValueTitles' => ['PROVIDED' => 'PROVIDED', 'MANAGED' => 'MANAGED'],
'type' => 'string',
'example' => 'MANAGED',
'title' => '',
],
'NlsAccessProfile' => [
'description' => 'Access account configuration',
'type' => 'object',
'properties' => [
'AccessProfileId' => ['description' => 'Third-party voice configuration ID', 'type' => 'string', 'example' => '0c4f978a-73bb-4841-bd84-75c0398edd4f', 'title' => ''],
],
'title' => '',
'example' => '',
],
'VocabularyId' => ['description' => 'Hotword ID', 'type' => 'string', 'example' => '0c4f978a-73bb-4841-bd84-75c0398edd5f', 'title' => ''],
'EndSilenceTimeout' => ['description' => 'Voice Activity Detection (VAD) sentence segmentation', 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''],
'CustomizationId' => ['description' => 'Self-learning language model ID (not currently supported)', 'type' => 'string', 'example' => '0c4f978a-73bb-4841-bd84-75c0398edd6f', 'title' => ''],
'SpeechNoiseThreshold' => ['description' => 'Noise threshold', 'type' => 'string', 'example' => '0', 'title' => ''],
'Model' => [
'description' => 'ASR model',
'enumValueTitles' => ['Paraformer' => 'Paraformer', 'Qwen' => 'Qwen', 'Fun' => 'Fun'],
'type' => 'string',
'example' => 'Paraformer',
'title' => '',
],
'CorrectionRules' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Pattern' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'Replacement' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => '',
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'SynthesizerConfig' => [
'description' => 'TTS configuration',
'type' => 'object',
'properties' => [
'NlsEngine' => [
'description' => 'TTS engine',
'enumValueTitles' => ['IFLYTEK' => 'IFLYTEK', 'VOLC' => 'VOLC', 'BAILIAN' => 'BAILIAN'],
'type' => 'string',
'example' => 'BAILIAN',
'title' => '',
],
'NlsAccessType' => [
'description' => 'TTS call method',
'enumValueTitles' => ['PROVIDED' => 'PROVIDED', 'MANAGED' => 'MANAGED'],
'type' => 'string',
'example' => 'MANAGED',
'title' => '',
],
'Model' => ['description' => 'TTS model', 'type' => 'string', 'example' => 'CosyVoice', 'title' => ''],
'Voice' => ['description' => 'Voice', 'type' => 'string', 'example' => 'longanyang', 'title' => ''],
'SpeechRate' => ['description' => 'Speech rate', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'Volume' => ['description' => 'Volume', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''],
'PitchRate' => ['description' => 'The speech pitch.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'NlsAccessProfile' => [
'description' => 'Access account configuration',
'type' => 'object',
'properties' => [
'AccessProfileId' => ['description' => 'Third-party voice configuration', 'type' => 'string', 'example' => '0c4f978a-73bb-4841-bd84-75c0398edd4f', 'title' => ''],
],
'title' => '',
'example' => '',
],
'PronRules' => [
'description' => 'List of TTS intervention dictionaries',
'type' => 'array',
'items' => [
'description' => 'TTS intervention dictionary object',
'type' => 'object',
'properties' => [
'Pattern' => ['description' => 'Word prone to errors', 'type' => 'string', 'example' => '还钱', 'title' => ''],
'Replacement' => ['description' => 'Replacement word', 'type' => 'string', 'example' => '环钱', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'ScriptProfile' => [
'description' => 'Dialogue capability configuration',
'type' => 'object',
'properties' => [
'ChatbotId' => ['description' => 'Chatbot ID', 'type' => 'string', 'example' => 'chatbot-cn-MQuyjjb666', 'title' => ''],
'AgentKey' => ['description' => 'Chatbot AgentKey', 'type' => 'string', 'example' => '1309723684579735_p_beebot_public', 'title' => ''],
'FunctionMeta' => [
'description' => 'Function Compute configuration',
'type' => 'object',
'properties' => [
'RegionId' => ['description' => 'Region where the function service is located', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'FunctionId' => ['description' => 'Function service ID', 'type' => 'string', 'example' => '9b752bbb-805a-4d3e-9013-eab5555c3fef', 'title' => ''],
'FunctionName' => ['description' => 'Function service name', 'type' => 'string', 'example' => 'my_funciton', 'title' => ''],
'HttpTriggerUrl' => ['description' => 'Function trigger URL', 'type' => 'string', 'example' => 'http://chat-xxxxx-v-yewiundukb.cn-hangzhou-xxx.run', 'title' => ''],
'HttpTriggerName' => ['description' => 'Function trigger name', 'type' => 'string', 'example' => 'defaultTrigger', 'title' => ''],
],
'title' => '',
'example' => '',
],
'Model' => ['description' => 'Dialogue model', 'type' => 'string', 'example' => 'qwen-plus', 'title' => ''],
'AgentProfile' => [
'description' => 'Dialogue agent configuration',
'type' => 'object',
'properties' => [
'ScriptProfileTemplateId' => ['description' => 'Scenario template ID', 'type' => 'string', 'example' => 'CCC_PROMPTS_DEFAULT', 'title' => ''],
'PromptsJson' => ['description' => 'Prompt JSON', 'type' => 'string', 'example' => '{\\"prompts\\":\\"我是一个聊天机器人。\\"}', 'title' => ''],
],
'title' => '',
'example' => '',
],
'NluAccessProfile' => [
'description' => 'Associated configuration',
'type' => 'object',
'properties' => [
'AccessProfileId' => ['description' => 'Third-party dialogue model configuration ID', 'type' => 'string', 'example' => 'c2c9baae-9351-4c49-a8cb-6f24a83a8718', 'title' => ''],
],
'title' => '',
'example' => '',
],
'OmniModel' => ['description' => 'Indicates whether the model is an Omni model.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'NluAccessType' => ['description' => 'Dialogue model call method', 'type' => 'string', 'example' => 'MANAGED', 'title' => ''],
'NluEngine' => ['description' => 'NLU engine', 'type' => 'string', 'example' => 'BEEBOT', 'title' => ''],
],
'title' => '',
'example' => '',
],
'InteractionConfig' => [
'description' => 'Interaction configuration',
'type' => 'object',
'properties' => [
'SilenceDetectionConfig' => [
'description' => 'Silence detection configuration',
'type' => 'object',
'properties' => [
'Timeout' => ['description' => 'Silence timeout period in milliseconds. If the user remains silent for longer than the specified value, a silence timeout message is played. The range is 2000 to 10000.', 'type' => 'integer', 'format' => 'int32', 'example' => '5000', 'title' => ''],
'MaxRepeats' => ['description' => 'Hang up after consecutive rounds of silence. This takes effect when NluEngine is set to PROMPTS for the current scenario.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
],
'title' => '',
'example' => '',
],
'EndConversationConfig' => [
'description' => 'Hang-up configuration',
'type' => 'object',
'properties' => [
'Delay' => ['description' => 'The hang-up action is executed x seconds after the hang-up message is played. The range is 0 to 5.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'Triggers' => [
'description' => 'List of special case interceptions',
'type' => 'array',
'items' => [
'description' => 'Special case interception object',
'type' => 'object',
'properties' => [
'TriggerType' => ['description' => 'TurnLimit: Maximum interaction rounds check. IntelligentVoiceAssistant: Voice assistant. InteractiveVoiceResponse: Extension transfer. KeyWords: Custom interception', 'type' => 'string', 'example' => 'TurnLimit', 'title' => ''],
'TurnLimit' => ['description' => 'Hangs up when the number of interaction rounds exceeds x. The range is 0 to 100. A value of 0 indicates that the hang-up feature for exceeding the round limit is disabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
'ClosingStatement' => ['description' => 'The message to play when hanging up after reaching the maximum number of rounds.', 'type' => 'string', 'example' => '感谢您的接听，祝您生活愉快，再见!', 'title' => ''],
'KeyWords' => [
'description' => 'List of custom interception keywords',
'type' => 'array',
'items' => ['description' => 'Custom interception keyword', 'type' => 'string', 'example' => '机器人助理', 'title' => ''],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'InitialGreetingDelayMilliseconds' => ['description' => 'The delay before playing audio after the call is connected, in milliseconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '2000', 'title' => ''],
'BackgroundMusicId' => ['description' => 'Background music ID', 'type' => 'string', 'example' => 'office-ambience', 'title' => ''],
],
'title' => '',
'example' => '',
],
'LabelConfig' => [
'description' => 'List of label objects',
'type' => 'array',
'items' => [
'description' => 'Label object',
'type' => 'object',
'properties' => [
'Name' => ['description' => 'Label name', 'type' => 'string', 'example' => '是否同意还款', 'title' => ''],
'Description' => ['description' => 'Label description', 'type' => 'string', 'example' => '用户是否同意于还款截止日期前还款', 'title' => ''],
'CandidateValues' => [
'description' => 'List of candidate values for the label',
'type' => 'array',
'items' => ['description' => 'Candidate value for the label', 'type' => 'string', 'example' => '同意', 'title' => ''],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'PublishedVersion' => [
'description' => 'Published version information',
'type' => 'object',
'properties' => [
'VersionId' => ['description' => 'Version ID', 'type' => 'string', 'example' => '8b77ff09-6a90-4784-8560-fdc2b860dc68', 'title' => ''],
'TranscriberConfig' => [
'description' => 'ASR configuration',
'type' => 'object',
'properties' => [
'NlsEngine' => ['description' => '**ASR engine**', 'type' => 'string', 'example' => 'BAILIAN', 'title' => ''],
'NlsAccessType' => ['description' => '**ASR call method**', 'type' => 'string', 'example' => 'MANAGED', 'title' => ''],
'NlsAccessProfile' => [
'description' => '**Associated configuration**',
'type' => 'object',
'properties' => [
'AccessProfileId' => ['description' => 'Third-party voice configuration ID (required when using third-party ASR services such as Doubao or iFLYTEK).', 'type' => 'string', 'example' => 'c2c9baae-9351-4c49-a8cb-6f24a83a8718', 'title' => ''],
],
'title' => '',
'example' => '',
],
'VocabularyId' => ['description' => 'Hotword table ID (obtained from the hotword management page).', 'type' => 'string', 'example' => 'cd97223f-42f2-4cd9-95af-e734e2fe1fe3', 'title' => ''],
'EndSilenceTimeout' => ['description' => 'Silence detection (sentence segmentation is triggered when the speaking interval exceeds x milliseconds, which is Voice Activity Detection (VAD)).', 'type' => 'integer', 'format' => 'int32', 'example' => '700', 'title' => ''],
'CustomizationId' => ['description' => 'Custom language model ID for ASR', 'type' => 'string', 'example' => 'cd97223f-42f2-4cd9-95af-e734e2fe1fe4', 'title' => ''],
'SpeechNoiseThreshold' => ['description' => 'Noise parameter threshold. The range is -100 to 100. The following describes the values:'."\n"
."\n"
.'The closer the value is to -100, the more likely noise is identified as speech.'."\n"
."\n"
.'The closer the value is to 100, the more likely speech is identified as noise.', 'type' => 'string', 'example' => '0', 'title' => ''],
'Model' => ['description' => 'ASR model', 'type' => 'string', 'example' => 'Paraformer', 'title' => ''],
'CorrectionRules' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Pattern' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'Replacement' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => '',
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'SynthesizerConfig' => [
'description' => 'TTS configuration',
'type' => 'object',
'properties' => [
'NlsEngine' => ['description' => '**TTS engine**', 'type' => 'string', 'example' => 'BAILIAN', 'title' => ''],
'NlsAccessType' => ['description' => '**TTS call method**', 'type' => 'string', 'example' => 'MANAGED', 'title' => ''],
'Model' => ['description' => '**TTS model**', 'type' => 'string', 'example' => 'CosyVoice', 'title' => ''],
'Voice' => ['description' => '**Voice**', 'type' => 'string', 'example' => 'longanyang', 'title' => ''],
'SpeechRate' => ['description' => '**Speech rate**'."\n"
.'The range is -500 to 500.'."\n"
.'The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'Volume' => ['description' => 'Volume'."\n"
.'The range is 0 to 100.'."\n"
.'The default value is 50.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''],
'PitchRate' => ['description' => 'Pitch rate'."\n"
.'The range is -500 to 500.'."\n"
.'The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'NlsAccessProfile' => [
'description' => 'Associated configuration',
'type' => 'object',
'properties' => [
'AccessProfileId' => ['description' => 'Third-party voice configuration ID (required when using third-party ASR services such as Doubao or iFLYTEK).', 'type' => 'string', 'example' => 'c2c9baae-9351-4c49-a8cb-6f24a83a8718', 'title' => ''],
],
'title' => '',
'example' => '',
],
'PronRules' => [
'description' => 'List of TTS intervention entries',
'type' => 'array',
'items' => [
'description' => 'The TTS pronunciation rule object.',
'type' => 'object',
'properties' => [
'Pattern' => ['description' => 'Word prone to errors', 'type' => 'string', 'example' => '还钱', 'title' => ''],
'Replacement' => ['description' => 'Homophone', 'type' => 'string', 'example' => '环钱', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'ScriptProfile' => [
'description' => 'Dialogue capability configuration',
'type' => 'object',
'properties' => [
'ChatbotId' => ['description' => 'Chatbot ID. This is required when NluEngine is set to BEEBOT for the current scenario.', 'type' => 'string', 'example' => 'chatbot-cn-MQuyjjb666', 'title' => ''],
'AgentKey' => ['description' => 'Chatbot AgentKey. This is required when NluEngine is set to BEEBOT for the current scenario.', 'type' => 'string', 'example' => '1309723684579735_p_beebot_public', 'title' => ''],
'FunctionMeta' => [
'description' => 'Function Compute configuration',
'type' => 'object',
'properties' => [
'RegionId' => ['description' => 'Region where the function service is located. This is required when NluEngine is set to FUNCTION for the current scenario.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'FunctionId' => ['description' => 'Function service ID. This is required when NluEngine is set to FUNCTION for the current scenario.', 'type' => 'string', 'example' => '9b752bbb-805a-4d3e-9013-eab5555c3fef', 'title' => ''],
'FunctionName' => ['description' => 'Function service name. This is required when NluEngine is set to FUNCTION for the current scenario.', 'type' => 'string', 'example' => 'my_function', 'title' => ''],
'HttpTriggerUrl' => ['description' => 'Function trigger URL. This is required when NluEngine is set to FUNCTION for the current scenario.', 'type' => 'string', 'example' => 'http://chat-xxxxx-v-yewiundukb.cn-hangzhou-xxx.run', 'title' => ''],
'HttpTriggerName' => ['description' => 'Function trigger name. This is required when NluEngine is set to FUNCTION for the current scenario.', 'type' => 'string', 'example' => 'defaultTrigger', 'title' => ''],
],
'title' => '',
'example' => '',
],
'Model' => ['description' => 'Dialogue model. This is required when NluEngine is set to PROMPTS for the current scenario.', 'type' => 'string', 'example' => 'qwen-plus', 'title' => ''],
'AgentProfile' => [
'description' => 'Dialogue agent configuration',
'type' => 'object',
'properties' => [
'ScriptProfileTemplateId' => ['description' => '**Scenario template ID**', 'type' => 'string', 'example' => 'CCC_PROMPTS_DEFAULT', 'title' => ''],
'PromptsJson' => ['description' => '**Prompt JSON**', 'type' => 'string', 'example' => '{\\"prompts\\":\\"我是一个聊天机器人。\\"}', 'title' => ''],
'Name' => ['description' => 'Dialogue agent name', 'type' => 'string', 'example' => 'test agent', 'title' => ''],
'Description' => ['description' => 'Dialogue agent description', 'type' => 'string', 'example' => '用于测试', 'title' => ''],
],
'title' => '',
'example' => '',
],
'NluAccessProfile' => [
'description' => '**Associated configuration**',
'type' => 'object',
'properties' => [
'AccessProfileId' => ['description' => 'Third-party dialogue model configuration ID', 'type' => 'string', 'example' => 'c2c9baae-9351-4c49-a8cb-6f24a83a8718', 'title' => ''],
],
'title' => '',
'example' => '',
],
'OmniModel' => ['description' => 'Indicates whether the model is an Omni model.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'NluAccessType' => ['description' => 'Dialogue model call method', 'type' => 'string', 'example' => 'MANAGED', 'title' => ''],
'NluEngine' => ['description' => 'NLU engine', 'type' => 'string', 'example' => 'BEEBOT', 'title' => ''],
],
'title' => '',
'example' => '',
],
'InteractionConfig' => [
'description' => 'Interaction configuration',
'type' => 'object',
'properties' => [
'SilenceDetectionConfig' => [
'description' => 'Silence detection configuration',
'type' => 'object',
'properties' => [
'Timeout' => ['description' => 'Silence timeout period in milliseconds.
'."\n"
.'If the user remains silent for longer than the specified value, a silence timeout message is played.
'."\n"
.'The range is 2000 to 10000.
', 'type' => 'integer', 'format' => 'int32', 'example' => '5000', 'title' => ''],
'MaxRepeats' => ['description' => 'Hang up after consecutive rounds of silence.
'."\n"
.'This takes effect when NluEngine is set to PROMPTS for the current scenario.
', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
],
'title' => '',
'example' => '',
],
'EndConversationConfig' => [
'description' => 'Hang-up configuration',
'type' => 'object',
'properties' => [
'Delay' => ['description' => 'The hang-up action is executed x seconds after the hang-up message is played. The range is 0 to 5.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'Triggers' => [
'description' => 'Special case interception',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'TriggerType' => ['description' => '- **TurnLimit**: Maximum interaction rounds check.'."\n"
."\n"
.'- **IntelligentVoiceAssistant**: Voice assistant.'."\n"
."\n"
.'- **InteractiveVoiceResponse**: Extension transfer.'."\n"
."\n"
.'- **KeyWords**: Custom interception.', 'type' => 'string', 'example' => 'TurnLimit', 'title' => ''],
'TurnLimit' => ['description' => '- Hangs up when the number of interaction rounds exceeds x.'."\n"
."\n"
.'- The range is 0 to 100.'."\n"
."\n"
.'- A value of 0 indicates that the hang-up feature for exceeding the round limit is disabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
'ClosingStatement' => ['description' => '- The message to play when hanging up after reaching the maximum number of rounds.', 'type' => 'string', 'example' => '感谢您的接听，祝您生活愉快，再见!', 'title' => ''],
'KeyWords' => [
'description' => '- List of custom interception keywords',
'type' => 'array',
'items' => ['description' => 'Custom interception keyword', 'type' => 'string', 'example' => '机器人助理', 'title' => ''],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'InitialGreetingDelayMilliseconds' => ['description' => '- The delay before playing audio after the call is connected.'."\n"
."\n"
.'- Unit: milliseconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '2000', 'title' => ''],
'BackgroundMusicId' => ['description' => 'Background music ID', 'type' => 'string', 'example' => 'office-ambience', 'title' => ''],
],
'title' => '',
'example' => '',
],
'LabelConfig' => [
'description' => 'Custom tag configuration',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Name' => ['description' => 'Label name', 'type' => 'string', 'example' => '是否同意还款', 'title' => ''],
'Description' => ['description' => 'Label description', 'type' => 'string', 'example' => '用户是否同意于还款截止日期前还款', 'title' => ''],
'CandidateValues' => [
'description' => 'List of candidate values for the label',
'type' => 'array',
'items' => ['description' => 'Candidate value for the label', 'type' => 'string', 'example' => '同意', 'title' => ''],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'Params' => [
'description' => 'List of dynamic error parameters',
'type' => 'array',
'items' => ['description' => 'Dynamic error parameter', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Retrieve scenario script configuration',
'summary' => 'Retrieves the detailed configuration information for the draft and published versions of a specified scenario.',
'description' => '## Request description'."\n"
."\n"
.'- This operation queries the detailed script configuration for a specific scenario. The configuration includes settings for Automatic Speech Recognition (ASR), Text-to-Speech (TTS), and dialogue capabilities.'."\n"
."\n"
.'- No additional parameters are required for the request. The response contains the configuration data for both the draft and published versions.'."\n"
."\n"
.'- The detailed configuration information is returned in the `Data` field of the response.',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"RequestId\\": \\"51E08AA9-8D1F-55F8-84A3-40635E2F0806\\",\\n \\"Data\\": {\\n \\"ScriptId\\": \\"64241e64-190c-45d1-af66-06f51c07b090\\",\\n \\"Name\\": \\"测试场景\\",\\n \\"Description\\": \\"test script\\",\\n \\"Concurrency\\": 10,\\n \\"CreatedTime\\": 1773228988000,\\n \\"UpdatedTime\\": 1773228988000,\\n \\"NluEngine\\": \\"BEEBOT\\",\\n \\"Status\\": \\"DRAFT\\",\\n \\"DraftVersion\\": {\\n \\"VersionId\\": \\"0c4f978a-73bb-4841-bd84-75c0398edd4e\\",\\n \\"TranscriberConfig\\": {\\n \\"NlsEngine\\": \\"BAILIAN\\",\\n \\"NlsAccessType\\": \\"MANAGED\\",\\n \\"NlsAccessProfile\\": {\\n \\"AccessProfileId\\": \\"0c4f978a-73bb-4841-bd84-75c0398edd4f\\"\\n },\\n \\"VocabularyId\\": \\"0c4f978a-73bb-4841-bd84-75c0398edd5f\\",\\n \\"EndSilenceTimeout\\": 500,\\n \\"CustomizationId\\": \\"0c4f978a-73bb-4841-bd84-75c0398edd6f\\",\\n \\"SpeechNoiseThreshold\\": \\"0\\",\\n \\"Model\\": \\"Paraformer\\",\\n \\"CorrectionRules\\": [\\n {\\n \\"Pattern\\": \\"\\",\\n \\"Replacement\\": \\"\\"\\n }\\n ]\\n },\\n \\"SynthesizerConfig\\": {\\n \\"NlsEngine\\": \\"BAILIAN\\",\\n \\"NlsAccessType\\": \\"MANAGED\\",\\n \\"Model\\": \\"CosyVoice\\",\\n \\"Voice\\": \\"longanyang\\",\\n \\"SpeechRate\\": 0,\\n \\"Volume\\": 50,\\n \\"PitchRate\\": 0,\\n \\"NlsAccessProfile\\": {\\n \\"AccessProfileId\\": \\"0c4f978a-73bb-4841-bd84-75c0398edd4f\\"\\n },\\n \\"PronRules\\": [\\n {\\n \\"Pattern\\": \\"还钱\\",\\n \\"Replacement\\": \\"环钱\\"\\n }\\n ]\\n },\\n \\"ScriptProfile\\": {\\n \\"ChatbotId\\": \\"chatbot-cn-MQuyjjb666\\",\\n \\"AgentKey\\": \\"1309723684579735_p_beebot_public\\",\\n \\"FunctionMeta\\": {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"FunctionId\\": \\"9b752bbb-805a-4d3e-9013-eab5555c3fef\\",\\n \\"FunctionName\\": \\"my_funciton\\",\\n \\"HttpTriggerUrl\\": \\"http://chat-xxxxx-v-yewiundukb.cn-hangzhou-xxx.run\\",\\n \\"HttpTriggerName\\": \\"defaultTrigger\\"\\n },\\n \\"Model\\": \\"qwen-plus\\",\\n \\"AgentProfile\\": {\\n \\"ScriptProfileTemplateId\\": \\"CCC_PROMPTS_DEFAULT\\",\\n \\"PromptsJson\\": \\"{\\\\\\\\\\\\\\"prompts\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"我是一个聊天机器人。\\\\\\\\\\\\\\"}\\"\\n },\\n \\"NluAccessProfile\\": {\\n \\"AccessProfileId\\": \\"c2c9baae-9351-4c49-a8cb-6f24a83a8718\\"\\n },\\n \\"OmniModel\\": true,\\n \\"NluAccessType\\": \\"MANAGED\\",\\n \\"NluEngine\\": \\"BEEBOT\\"\\n },\\n \\"InteractionConfig\\": {\\n \\"SilenceDetectionConfig\\": {\\n \\"Timeout\\": 5000,\\n \\"MaxRepeats\\": 3\\n },\\n \\"EndConversationConfig\\": {\\n \\"Delay\\": 1,\\n \\"Triggers\\": [\\n {\\n \\"TriggerType\\": \\"TurnLimit\\",\\n \\"TurnLimit\\": 20,\\n \\"ClosingStatement\\": \\"感谢您的接听，祝您生活愉快，再见!\\",\\n \\"KeyWords\\": [\\n \\"机器人助理\\"\\n ]\\n }\\n ]\\n },\\n \\"InitialGreetingDelayMilliseconds\\": 2000,\\n \\"BackgroundMusicId\\": \\"office-ambience\\"\\n },\\n \\"LabelConfig\\": [\\n {\\n \\"Name\\": \\"是否同意还款\\",\\n \\"Description\\": \\"用户是否同意于还款截止日期前还款\\",\\n \\"CandidateValues\\": [\\n \\"同意\\"\\n ]\\n }\\n ]\\n },\\n \\"PublishedVersion\\": {\\n \\"VersionId\\": \\"8b77ff09-6a90-4784-8560-fdc2b860dc68\\",\\n \\"TranscriberConfig\\": {\\n \\"NlsEngine\\": \\"BAILIAN\\",\\n \\"NlsAccessType\\": \\"MANAGED\\",\\n \\"NlsAccessProfile\\": {\\n \\"AccessProfileId\\": \\"c2c9baae-9351-4c49-a8cb-6f24a83a8718\\"\\n },\\n \\"VocabularyId\\": \\"cd97223f-42f2-4cd9-95af-e734e2fe1fe3\\",\\n \\"EndSilenceTimeout\\": 700,\\n \\"CustomizationId\\": \\"cd97223f-42f2-4cd9-95af-e734e2fe1fe4\\",\\n \\"SpeechNoiseThreshold\\": \\"0\\",\\n \\"Model\\": \\"Paraformer\\",\\n \\"CorrectionRules\\": [\\n {\\n \\"Pattern\\": \\"\\",\\n \\"Replacement\\": \\"\\"\\n }\\n ]\\n },\\n \\"SynthesizerConfig\\": {\\n \\"NlsEngine\\": \\"BAILIAN\\",\\n \\"NlsAccessType\\": \\"MANAGED\\",\\n \\"Model\\": \\"CosyVoice\\",\\n \\"Voice\\": \\"longanyang\\",\\n \\"SpeechRate\\": 0,\\n \\"Volume\\": 50,\\n \\"PitchRate\\": 0,\\n \\"NlsAccessProfile\\": {\\n \\"AccessProfileId\\": \\"c2c9baae-9351-4c49-a8cb-6f24a83a8718\\"\\n },\\n \\"PronRules\\": [\\n {\\n \\"Pattern\\": \\"还钱\\",\\n \\"Replacement\\": \\"环钱\\"\\n }\\n ]\\n },\\n \\"ScriptProfile\\": {\\n \\"ChatbotId\\": \\"chatbot-cn-MQuyjjb666\\",\\n \\"AgentKey\\": \\"1309723684579735_p_beebot_public\\",\\n \\"FunctionMeta\\": {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"FunctionId\\": \\"9b752bbb-805a-4d3e-9013-eab5555c3fef\\",\\n \\"FunctionName\\": \\"my_function\\",\\n \\"HttpTriggerUrl\\": \\"http://chat-xxxxx-v-yewiundukb.cn-hangzhou-xxx.run\\",\\n \\"HttpTriggerName\\": \\"defaultTrigger\\"\\n },\\n \\"Model\\": \\"qwen-plus\\",\\n \\"AgentProfile\\": {\\n \\"ScriptProfileTemplateId\\": \\"CCC_PROMPTS_DEFAULT\\",\\n \\"PromptsJson\\": \\"{\\\\\\\\\\\\\\"prompts\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"我是一个聊天机器人。\\\\\\\\\\\\\\"}\\",\\n \\"Name\\": \\"test agent\\",\\n \\"Description\\": \\"用于测试\\"\\n },\\n \\"NluAccessProfile\\": {\\n \\"AccessProfileId\\": \\"c2c9baae-9351-4c49-a8cb-6f24a83a8718\\"\\n },\\n \\"OmniModel\\": true,\\n \\"NluAccessType\\": \\"MANAGED\\",\\n \\"NluEngine\\": \\"BEEBOT\\"\\n },\\n \\"InteractionConfig\\": {\\n \\"SilenceDetectionConfig\\": {\\n \\"Timeout\\": 5000,\\n \\"MaxRepeats\\": 3\\n },\\n \\"EndConversationConfig\\": {\\n \\"Delay\\": 1,\\n \\"Triggers\\": [\\n {\\n \\"TriggerType\\": \\"TurnLimit\\",\\n \\"TurnLimit\\": 20,\\n \\"ClosingStatement\\": \\"感谢您的接听，祝您生活愉快，再见!\\",\\n \\"KeyWords\\": [\\n \\"机器人助理\\"\\n ]\\n }\\n ]\\n },\\n \\"InitialGreetingDelayMilliseconds\\": 2000,\\n \\"BackgroundMusicId\\": \\"office-ambience\\"\\n },\\n \\"LabelConfig\\": [\\n {\\n \\"Name\\": \\"是否同意还款\\",\\n \\"Description\\": \\"用户是否同意于还款截止日期前还款\\",\\n \\"CandidateValues\\": [\\n \\"同意\\"\\n ]\\n }\\n ]\\n }\\n },\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:GetScript',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'GetScriptTrendingReport' => [
'summary' => 'View the scenario metric trend chart',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '12f407b22cbe4890ac595f09985848d5', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'formData',
'schema' => ['description' => 'The scenario ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '891264b9-5883-4068-94a6-241ceb8d51e4', 'title' => ''],
],
[
'name' => 'StartTime',
'in' => 'formData',
'schema' => ['description' => 'The start time of the statistics. The parameter value is a UNIX timestamp in milliseconds. It indicates the number of milliseconds that have elapsed since 00:00:00 UTC on January 1, 1970. The following limits apply:'."\n"
."\n"
.'1. Valid start time: You can query data collected within the last 365 days from the current date.'."\n"
."\n"
.'2. Alignment with time granularity: If you query data by hour, the minutes, seconds, and milliseconds must be 0. If you query data by day, the hours, minutes, seconds, and milliseconds must be 0.'."\n"
."\n"
.'3. If the specified timestamp is not aligned with the time granularity, the system automatically rounds it up to the next valid time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '1582267398628', 'title' => ''],
],
[
'name' => 'EndTime',
'in' => 'formData',
'schema' => ['description' => 'The end time of the statistics. The parameter value must be a UNIX timestamp in milliseconds. It indicates the number of milliseconds that have elapsed since 00:00:00 UTC on January 1, 1970. The following limits apply:'."\n"
."\n"
.'1. Time range: You can query data by hour for up to 7 days or by day for up to 180 days.'."\n"
."\n"
.'2. Alignment with time granularity: If you query data by hour, the minutes, seconds, and milliseconds must be 0. If you query data by day, the hours, minutes, seconds, and milliseconds must be 0. If the specified timestamp is not aligned with the time granularity, the system automatically rounds it up to the next valid time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '1582103299434', 'title' => ''],
],
[
'name' => 'TimeInterval',
'in' => 'formData',
'schema' => ['description' => 'The time interval.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '1d', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response schema.',
'title' => '',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9DB8BA95-4513-54B9-9C67-A28909CFB4AD'],
'Code' => ['description' => 'The service-specific error code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'get upload tool url success', 'title' => ''],
'Data' => [
'description' => 'An array of scenario template objects.',
'type' => 'array',
'items' => [
'description' => 'An object that contains the metrics for a single time interval.',
'type' => 'object',
'properties' => [
'StatsTime' => ['description' => 'The start time of the interval. The value is a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1774881208361', 'title' => ''],
'UsedConcurrency' => ['description' => 'The peak concurrency for the interval.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'ConfiguredConcurrency' => ['description' => 'The configured concurrency limit.', 'type' => 'integer', 'format' => 'int64', 'example' => '13', 'title' => ''],
'CallsOffered' => ['description' => 'The number of offered calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'CallsHandled' => ['description' => 'The number of handled calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '7', 'title' => ''],
'CallsRejected' => ['description' => 'The number of rejected calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''],
'CallsResolved' => ['description' => 'The number of resolved calls, based on the large model\'s evaluation.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''],
'TotalInputTokens' => ['description' => 'This parameter is reserved for future use.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'TotalOutputTokens' => ['description' => 'This parameter is reserved for future use.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'TotalTokens' => ['description' => 'This parameter is reserved for future use.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'TotalTalkTime' => ['description' => 'The total talk time, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
'MaxTalkTime' => ['description' => 'The maximum talk time, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
'RejectionBreakdown' => ['description' => 'A JSON string that provides a breakdown of rejection reasons.', 'type' => 'string', 'example' => '{'."\n"
.' "ConcurrentLimitExceeded":3'."\n"
.'}', 'title' => ''],
'ReleaseReasonBreakdown' => ['description' => 'A JSON string that provides a breakdown of call disconnection reasons.', 'type' => 'string', 'example' => '{'."\n"
.' "SilenceTimeout":1,'."\n"
.' "TurnsLimitExceeded":1,'."\n"
.' "Exception":1,'."\n"
.' "Transferred":1,'."\n"
.' "Normal":1'."\n"
.'}', 'title' => ''],
'LabelBreakDown' => ['description' => 'A JSON string that provides a breakdown of label distribution.', 'type' => 'string', 'example' => '{'."\n"
.' "label1":{ '."\n"
.' "label1_sub1":10,'."\n"
.' "label1_sub2":2'."\n"
.'}'."\n"
.'}', 'title' => ''],
'TalkTurnsDistribution' => ['description' => 'A JSON string that provides a breakdown of conversation turn distribution.', 'type' => 'string', 'example' => '{'."\n"
.' "1":2,'."\n"
.' "10":3'."\n"
.'}', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'Params' => [
'description' => 'An array of error parameters.',
'type' => 'array',
'items' => ['description' => 'A parameter value related to the error.', 'type' => 'string', 'example' => '[\'zhenhyuantest\']', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Retrieve Trend Indicator for Scenario ',
'description' => '## Request'."\n"
."\n"
.'- This API returns the script configuration for a specific scenario, including settings for ASR, TTS, and conversational capability.'."\n"
."\n"
.'- This request requires no parameters. The response includes configuration data for both the draft and published versions.'."\n"
."\n"
.'- Check the `Data` field for configuration details.',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:GetScriptTrendingReport',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9DB8BA95-4513-54B9-9C67-A28909CFB4AD\\",\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"get upload tool url success\\",\\n \\"Data\\": [\\n {\\n \\"StatsTime\\": 1774881208361,\\n \\"UsedConcurrency\\": 10,\\n \\"ConfiguredConcurrency\\": 13,\\n \\"CallsOffered\\": 10,\\n \\"CallsHandled\\": 7,\\n \\"CallsRejected\\": 3,\\n \\"CallsResolved\\": 3,\\n \\"TotalInputTokens\\": 0,\\n \\"TotalOutputTokens\\": 0,\\n \\"TotalTokens\\": 0,\\n \\"TotalTalkTime\\": 100,\\n \\"MaxTalkTime\\": 20,\\n \\"RejectionBreakdown\\": \\"{\\\\n \\\\\\"ConcurrentLimitExceeded\\\\\\":3\\\\n}\\",\\n \\"ReleaseReasonBreakdown\\": \\"{\\\\n \\\\\\"SilenceTimeout\\\\\\":1,\\\\n \\\\\\"TurnsLimitExceeded\\\\\\":1,\\\\n \\\\\\"Exception\\\\\\":1,\\\\n \\\\\\"Transferred\\\\\\":1,\\\\n \\\\\\"Normal\\\\\\":1\\\\n}\\",\\n \\"LabelBreakDown\\": \\"{\\\\n \\\\\\"label1\\\\\\":{ \\\\n \\\\\\"label1_sub1\\\\\\":10,\\\\n \\\\\\"label1_sub2\\\\\\":2\\\\n}\\\\n}\\",\\n \\"TalkTurnsDistribution\\": \\"{\\\\n \\\\\\"1\\\\\\":2,\\\\n \\\\\\"10\\\\\\":3\\\\n}\\"\\n }\\n ],\\n \\"Params\\": [\\n \\"[\'zhenhyuantest\']\\"\\n ]\\n}","type":"json"}]',
'translator' => 'machine',
],
'GetSubscription' => [
'summary' => 'Retrieves the details of a message queue (MQ) subscription.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '19ac2375-53e3-477f-abe9-6cd334227981', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The data returned.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The request status. `OK` indicates that the request was successful.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7401D698-0AAC-5909-B68E-88C68805FFB8', 'title' => ''],
'Data' => [
'description' => 'The subscription details.',
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'Disabled' => [
'description' => 'Specifies whether the subscription is disabled.',
'enumValueTitles' => ['', ''],
'type' => 'boolean',
'example' => '0',
'title' => '',
],
'MqType' => [
'description' => 'The message queue type.',
'enumValueTitles' => ['ROCKET_MQ_4' => '', 'ROCKET_MQ_5' => ''],
'type' => 'string',
'example' => 'ROCKET_MQ_4',
'title' => '',
],
'Endpoint' => ['description' => 'The message queue endpoint. This parameter is required if `MqType` is set to `ROCKET_MQ_4` or `ROCKET_MQ_5`. The example endpoint is for the China (Hangzhou) region.', 'type' => 'string', 'example' => 'rmq-cn-l4p89zajz67.cn-hangzhou.rmq.aliyuncs.com:8080', 'title' => ''],
'Topic' => ['description' => 'The message queue topic. This parameter is required if `MqType` is set to `ROCKET_MQ_4` or `ROCKET_MQ_5`.', 'type' => 'string', 'example' => 'test', 'title' => ''],
'UserName' => ['description' => 'The username for authentication. This parameter is required if `MqType` is set to `ROCKET_MQ_5`.', 'type' => 'string', 'example' => 'username', 'title' => ''],
'Password' => ['description' => 'The password for authentication. This parameter is required if `MqType` is set to `ROCKET_MQ_5`.', 'type' => 'string', 'example' => 'pwd', 'title' => ''],
'MqInstanceId' => ['description' => 'The RocketMQ instance ID. This parameter is required if `MqType` is set to `ROCKET_MQ_5`.', 'type' => 'string', 'example' => 'rmq-cn-l4p89zajz67.cn', 'title' => ''],
'ProducerId' => ['description' => 'The producer ID. This parameter is required if `MqType` is set to `ROCKET_MQ_4`.', 'type' => 'string', 'example' => 'user1', 'title' => ''],
'EventList' => [
'description' => 'A list of subscribed events.',
'type' => 'array',
'items' => [
'description' => 'The details of a subscribed event.',
'type' => 'object',
'properties' => [
'Name' => ['description' => 'The event name.', 'type' => 'string', 'example' => 'Released', 'title' => ''],
'DisplayName' => ['description' => 'The event\'s display name.', 'type' => 'string', 'example' => '通话结束', 'title' => ''],
'Disabled' => [
'description' => 'Specifies whether pushes for this event are disabled.',
'enumValueTitles' => ['false' => '', 'true' => ''],
'type' => 'boolean',
'example' => 'false',
'title' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'Params' => [
'description' => 'Dynamic parameters used in the error message.',
'type' => 'array',
'items' => ['description' => 'A dynamic parameter from the error message.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Retrieve message subscription configuration information ',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"RequestId\\": \\"7401D698-0AAC-5909-B68E-88C68805FFB8\\",\\n \\"Data\\": {\\n \\"InstanceId\\": \\"af81a389-91f0-4157-8d82-720edd02b66a\\",\\n \\"Disabled\\": true,\\n \\"MqType\\": \\"ROCKET_MQ_4\\",\\n \\"Endpoint\\": \\"rmq-cn-l4p89zajz67.cn-hangzhou.rmq.aliyuncs.com:8080\\",\\n \\"Topic\\": \\"test\\",\\n \\"UserName\\": \\"username\\",\\n \\"Password\\": \\"pwd\\",\\n \\"MqInstanceId\\": \\"rmq-cn-l4p89zajz67.cn\\",\\n \\"ProducerId\\": \\"user1\\",\\n \\"EventList\\": [\\n {\\n \\"Name\\": \\"Released\\",\\n \\"DisplayName\\": \\"通话结束\\",\\n \\"Disabled\\": false\\n }\\n ]\\n },\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:GetSubscription',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'GetVocabulary' => [
'summary' => 'Gets the details of a specified vocabulary.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'd74d6290-7cbe-4436-b5d7-014ebb0f4060', 'title' => ''],
],
[
'name' => 'VocabularyId',
'in' => 'formData',
'schema' => ['description' => 'The vocabulary ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'd74d6290-7cbe-4436-b5d7-014ebb0f4061', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Response schema',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '97E7ED13-6884-52D7-B97E-C780D7870680', 'title' => ''],
'Data' => [
'description' => 'The vocabulary object.',
'type' => 'object',
'properties' => [
'VocabularyId' => ['description' => 'The vocabulary ID.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66b', 'title' => ''],
'Name' => ['description' => 'The vocabulary name.', 'type' => 'string', 'example' => '金融场景热词', 'title' => ''],
'Description' => ['description' => 'The vocabulary description.', 'type' => 'string', 'example' => '包含金融场景专业术语', 'title' => ''],
'CreatedTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1773453676000', 'title' => ''],
'UpdatedTime' => ['description' => 'The update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1773453676000', 'title' => ''],
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'TenantId' => ['description' => 'The tenant ID.', 'type' => 'string', 'example' => '1308144684576655', 'title' => ''],
'WordCount' => ['description' => 'The word count.', 'type' => 'string', 'example' => '50', 'title' => ''],
'Words' => ['description' => 'A JSON string that contains the words and their weights.', 'type' => 'string', 'example' => '{\\"苹果\\":\\"2\\",\\"香蕉\\":\\"3\\"}', 'title' => ''],
],
'title' => '',
'example' => '',
],
'Params' => [
'description' => 'A list of dynamic error parameters.',
'type' => 'array',
'items' => ['description' => 'A dynamic error parameter.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Retrieve hotword information ',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"RequestId\\": \\"97E7ED13-6884-52D7-B97E-C780D7870680\\",\\n \\"Data\\": {\\n \\"VocabularyId\\": \\"af81a389-91f0-4157-8d82-720edd02b66b\\",\\n \\"Name\\": \\"金融场景热词\\",\\n \\"Description\\": \\"包含金融场景专业术语\\",\\n \\"CreatedTime\\": 1773453676000,\\n \\"UpdatedTime\\": 1773453676000,\\n \\"InstanceId\\": \\"af81a389-91f0-4157-8d82-720edd02b66a\\",\\n \\"TenantId\\": \\"1308144684576655\\",\\n \\"WordCount\\": \\"50\\",\\n \\"Words\\": \\"{\\\\\\\\\\\\\\"苹果\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"香蕉\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"3\\\\\\\\\\\\\\"}\\"\\n },\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:GetVocabulary',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ImportVocabulary' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
],
[
'name' => 'FileKey',
'in' => 'formData',
'schema' => ['description' => 'The path to the uploaded file.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'vocabulary/热词导入单元测试.zip', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The data returned.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7401D698-0AAC-5909-B68E-88C68805FFB8'],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'Code' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Data' => [
'description' => 'A list of vocabulary IDs.',
'type' => 'array',
'items' => ['description' => 'The vocabulary ID.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66b', 'title' => ''],
'title' => '',
'example' => '',
],
'Params' => [
'description' => 'Parameters used to dynamically generate the error message.',
'type' => 'array',
'items' => ['description' => 'A parameter used to dynamically generate the error message.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Import hotwords ',
'summary' => 'Imports a custom vocabulary.',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7401D698-0AAC-5909-B68E-88C68805FFB8\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66b\\"\\n ],\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'voicebot:ImportVocabulary',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ListBackgroundMusics' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response body.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7401D698-0AAC-5909-B68E-88C68805FFB8'],
'Code' => ['description' => 'The internal error code. A value of `OK` indicates that the request was successful.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'Data' => [
'description' => 'The paginated list of background music.',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => 'The returned page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries on the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'TotalCount' => ['description' => 'The total number of matching entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
'BackgroundMusics' => [
'description' => 'The list of background music.',
'type' => 'array',
'items' => [
'description' => 'A background music item.',
'type' => 'object',
'properties' => [
'Id' => ['description' => 'The ID of the background music.', 'type' => 'string', 'example' => '3258b551-4847-45fa-bbd8-838d90b90080', 'title' => ''],
'Name' => ['description' => 'The name of the background music.', 'type' => 'string', 'example' => '办公氛围', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'Params' => [
'description' => 'The list of dynamic error parameters.',
'type' => 'array',
'items' => ['description' => 'A dynamic error parameter.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Retrieve background music list ',
'summary' => 'Returns a paginated list of background music.',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7401D698-0AAC-5909-B68E-88C68805FFB8\\",\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\n \\"BackgroundMusics\\": [\\n {\\n \\"Id\\": \\"3258b551-4847-45fa-bbd8-838d90b90080\\",\\n \\"Name\\": \\"办公氛围\\"\\n }\\n ]\\n },\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:ListBackgroundMusics',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ListCallCenterProviders' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'maxLength' => 64, 'example' => '36e9a4cd-a821-4f78-86fa-a9a4aefeea2e', 'title' => ''],
],
[
'name' => 'ProviderId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the call center provider.', 'type' => 'string', 'required' => false, 'example' => 'xxxxxxxxx', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'minimum' => '1', 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The data returned.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => '75BAAB9B-40B2-5FF5-A59A-7BCF8154C6EE'],
'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'Data' => [
'description' => 'The call center provider data.',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'Providers' => [
'description' => 'A list of call center providers.',
'type' => 'array',
'items' => [
'description' => 'A call center provider.',
'type' => 'object',
'properties' => [
'ProviderId' => ['description' => 'The call center provider ID.', 'type' => 'string', 'example' => 'xxxxxxxxx', 'title' => ''],
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => '36e9a4cd-a821-4f78-86fa-a9a4aefeea2e', 'title' => ''],
'ProviderType' => [
'description' => 'The provider type.'."\n"
."\n"
.'> - `CCC`: Cloud Contact Center'."\n"
.'>'."\n"
.'> - `CUSTOM`: customer-owned contact center',
'enumValueTitles' => ['CCC' => 'Cloud Contact Center', 'CUSTOM' => 'customer-owned contact center'],
'type' => 'string',
'example' => 'CCC',
'title' => '',
],
'Name' => ['description' => 'The service provider name.', 'type' => 'string', 'example' => '云联络中心内部服务提供商', 'title' => ''],
'DisplayName' => ['description' => 'The display name of the service provider.', 'type' => 'string', 'example' => '云联络中心内部服务提供商', 'title' => ''],
'ReferTo' => ['description' => 'The Refer address.> Required if the transfer mode is `Refer`.>', 'type' => 'string', 'example' => '-', 'title' => ''],
'TrunkId' => ['description' => 'The trunk ID.', 'type' => 'string', 'example' => 'trunk-xxx', 'title' => ''],
'Originator' => ['description' => 'The originator of the call transfer. Required if the transfer mode is `Bridge`.', 'type' => 'string', 'example' => '010****', 'title' => ''],
'Destination' => ['description' => 'The destination of the call transfer. Required if the transfer mode is `Bridge`.', 'type' => 'string', 'example' => '153*********', 'title' => ''],
'Extras' => ['description' => 'The extra data.> Format: `k1=v1;k2=v2`>', 'type' => 'string', 'example' => 'key1=value1', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'Params' => [
'description' => 'A list of dynamic error parameters.',
'type' => 'array',
'items' => ['description' => 'A dynamic error parameter.', 'type' => 'string', 'example' => '[]', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'List query for human service providers ',
'summary' => 'System Management > Manual Service Provider Management > Query',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75BAAB9B-40B2-5FF5-A59A-7BCF8154C6EE\\",\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Providers\\": [\\n {\\n \\"ProviderId\\": \\"xxxxxxxxx\\",\\n \\"InstanceId\\": \\"36e9a4cd-a821-4f78-86fa-a9a4aefeea2e\\",\\n \\"ProviderType\\": \\"CCC\\",\\n \\"Name\\": \\"云联络中心内部服务提供商\\",\\n \\"DisplayName\\": \\"云联络中心内部服务提供商\\",\\n \\"ReferTo\\": \\"-\\",\\n \\"TrunkId\\": \\"trunk-xxx\\",\\n \\"Originator\\": \\"010****\\",\\n \\"Destination\\": \\"153*********\\",\\n \\"Extras\\": \\"key1=value1\\"\\n }\\n ]\\n },\\n \\"Params\\": [\\n \\"[]\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:ListCallCenterProviders',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ListCallDetailRecords' => [
'summary' => 'Gets the call list.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '20', 'example' => '10', 'title' => ''],
],
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
],
[
'name' => 'StartTime',
'in' => 'formData',
'schema' => ['description' => 'The beginning of the time range to query. This value is a Unix timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'maxLength' => 32, 'example' => '1774858849987', 'title' => ''],
],
[
'name' => 'EndTime',
'in' => 'formData',
'schema' => ['description' => 'The end of the time range to query. This value is a Unix timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '1582103299434', 'title' => ''],
],
[
'name' => 'SessionIds',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => 'The session IDs.'."\n"
."\n"
.'> The value is a JSON array of strings. Example: `["session-id-1","session-id-2"]`.',
'type' => 'array',
'items' => ['description' => 'The session ID.'."\n"
."\n"
.'>', 'type' => 'string', 'required' => false, 'example' => '[552276253]', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'ScriptId',
'in' => 'formData',
'schema' => ['description' => 'The script ID.', 'type' => 'string', 'required' => false, 'example' => '64241e64-190c-45d1-af66-06f51c07b090', 'title' => ''],
],
[
'name' => 'Caller',
'in' => 'formData',
'schema' => ['description' => 'The caller\'s number.', 'type' => 'string', 'required' => false, 'example' => '09876543210,', 'title' => ''],
],
[
'name' => 'Callee',
'in' => 'formData',
'schema' => ['description' => 'The callee\'s number.', 'type' => 'string', 'required' => false, 'example' => '18104560087', 'title' => ''],
],
[
'name' => 'DispositionCodes',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => 'The disposition codes.',
'type' => 'array',
'items' => ['description' => 'A disposition code.', 'type' => 'string', 'required' => false, 'example' => '[Answered]', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'DispositionReasons',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => 'The disposition reasons.',
'type' => 'array',
'items' => ['description' => 'A disposition reason.', 'type' => 'string', 'required' => false, 'example' => '[SilenceTimeout]', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'MinTalkTurns',
'in' => 'query',
'schema' => ['description' => 'The minimum number of conversational turns.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '0', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'MaxTalkTurns',
'in' => 'query',
'schema' => ['description' => 'The maximum number of conversational turns.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'AccessChannelId',
'in' => 'query',
'schema' => ['description' => 'The channel ID.', 'type' => 'string', 'required' => false, 'example' => '33606503-c22c-4547-a51c-dda5e8d87962', 'title' => ''],
],
[
'name' => 'AccessChannelType',
'in' => 'query',
'schema' => ['description' => 'The channel type.', 'type' => 'string', 'required' => false, 'example' => 'PSTN', 'title' => ''],
],
[
'name' => 'DraftVersion',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to query a draft.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'IssueResolved',
'in' => 'query',
'schema' => ['description' => 'Indicates whether the issue was resolved.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The data returned in the response.',
'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'ID of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'A8AED3C8-F57B-5D71-9A34-4A170287533F'],
'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''],
'Data' => [
'description' => 'An object containing the returned call records.',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries that match the query.', 'type' => 'integer', 'format' => 'int32', 'example' => '362', 'title' => ''],
'CallDetailRecords' => [
'description' => 'A list of call detail records.',
'type' => 'array',
'items' => [
'description' => 'A call detail record.',
'type' => 'object',
'properties' => [
'SessionId' => ['description' => 'The session ID.', 'type' => 'string', 'example' => '99eebcba-7f8a-4a54-b0da-603ada79d8e2', 'title' => ''],
'StartTime' => ['description' => 'The start time of the session, as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1767315903531', 'title' => ''],
'EndTime' => ['description' => 'The end time of the session, as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1767315903531', 'title' => ''],
'Caller' => ['description' => 'The caller\'s phone number.', 'type' => 'string', 'example' => '4001027277', 'title' => ''],
'Callee' => ['description' => 'The callee\'s phone number.', 'type' => 'string', 'example' => '15100000001', 'title' => ''],
'DispositionCode' => ['description' => 'The disposition code.', 'type' => 'string', 'example' => 'Answered', 'title' => ''],
'DispositionReason' => ['description' => 'The disposition reason.', 'type' => 'string', 'example' => 'ConcurrentLimitExceeded', 'title' => ''],
'ReleaseInitiator' => ['description' => 'The party who released the call.', 'type' => 'string', 'example' => 'Customer', 'title' => ''],
'TransferType' => ['description' => 'The transfer type.', 'type' => 'string', 'example' => 'Agent', 'title' => ''],
'TransferTarget' => ['description' => 'The transfer target.', 'type' => 'string', 'example' => 'default@testinstance1', 'title' => ''],
'TalkTurns' => ['description' => 'The number of talk turns.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'TalkTime' => ['description' => 'The talk time, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '245', 'title' => ''],
'Duration' => ['description' => 'The total duration of the call, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '265', 'title' => ''],
'IssueResolved' => ['description' => 'Indicates whether the customer\'s issue was resolved.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'ResolutionEvidence' => ['description' => 'The evidence for the `IssueResolved` status.', 'type' => 'string', 'example' => 'unknown', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'Params' => [
'description' => 'A list of invalid parameters in the request.',
'type' => 'array',
'items' => ['description' => 'An invalid parameter from the request.', 'type' => 'string', 'example' => '[]', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Retrieve call list',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A8AED3C8-F57B-5D71-9A34-4A170287533F\\",\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 362,\\n \\"CallDetailRecords\\": [\\n {\\n \\"SessionId\\": \\"99eebcba-7f8a-4a54-b0da-603ada79d8e2\\",\\n \\"StartTime\\": 1767315903531,\\n \\"EndTime\\": 1767315903531,\\n \\"Caller\\": \\"4001027277\\",\\n \\"Callee\\": \\"15100000001\\",\\n \\"DispositionCode\\": \\"Answered\\",\\n \\"DispositionReason\\": \\"ConcurrentLimitExceeded\\",\\n \\"ReleaseInitiator\\": \\"Customer\\",\\n \\"TransferType\\": \\"Agent\\",\\n \\"TransferTarget\\": \\"default@testinstance1\\",\\n \\"TalkTurns\\": 1,\\n \\"TalkTime\\": 245,\\n \\"Duration\\": 265,\\n \\"IssueResolved\\": false,\\n \\"ResolutionEvidence\\": \\"unknown\\"\\n }\\n ]\\n },\\n \\"Params\\": [\\n \\"[]\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:ListCallDetailRecords',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ListCloneVoice' => [
'summary' => 'Lists the cloned voices in an instance.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
],
[
'name' => 'Status',
'in' => 'formData',
'schema' => [
'description' => 'The status of the cloned voice.',
'enumValueTitles' => ['Draft' => ': The cloned voice is a draft and not available for synthesis.', 'Published' => ': The cloned voice is published and available for synthesis.'],
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'Published',
'title' => '',
],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => 'The page number to return. Defaults to 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => 'The number of entries to return on each page. Defaults to 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response object.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7401D698-0AAC-5909-B68E-88C68805FFB8'],
'Code' => ['description' => 'Internal error code', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'Data' => [
'description' => 'The paginated list of cloned voices.',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => 'The returned page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'TotalCount' => ['description' => 'The total number of cloned voices that match the query.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'CloneVoices' => [
'description' => 'A list of cloned voices for the current page.',
'type' => 'array',
'items' => [
'description' => 'Details of a cloned voice.',
'type' => 'object',
'properties' => [
'CloneVoiceId' => ['description' => 'The ID of the cloned voice.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66b', 'title' => ''],
'CreatedTime' => ['description' => 'The creation timestamp of the cloned voice.', 'type' => 'integer', 'format' => 'int64', 'example' => '1764900994000', 'title' => ''],
'UpdatedTime' => ['description' => 'The last update timestamp of the cloned voice.', 'type' => 'integer', 'format' => 'int64', 'example' => '1764900994000', 'title' => ''],
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'TenantId' => ['description' => 'The tenant ID.', 'type' => 'string', 'example' => '1308144684576655', 'title' => ''],
'Voice' => ['description' => 'The base voice used for cloning.', 'type' => 'string', 'example' => 'cosyvoice-v3-plus-voicebot2-3666e4bbb2b94832ac4f4107b5804c34', 'title' => ''],
'Name' => ['description' => 'The name of the cloned voice.', 'type' => 'string', 'example' => '测试克隆音', 'title' => ''],
'NlsEngine' => [
'description' => 'The TTS engine.',
'enumValueTitles' => [],
'type' => 'string',
'example' => 'BAILIAN',
'title' => '',
],
'Status' => [
'description' => 'The status of the cloned voice.',
'enumValueTitles' => ['Draft' => ': The cloned voice is a draft and not available for synthesis.', 'Published' => ': The cloned voice is published and available for synthesis.'],
'type' => 'string',
'example' => 'Published',
'title' => '',
],
'Model' => [
'description' => 'The cloning model.',
'enumValueTitles' => ['CosyVoice' => '', 'QwenVc' => ''],
'type' => 'string',
'example' => 'CosyVoice',
'title' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Retrieve clone voice list ',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7401D698-0AAC-5909-B68E-88C68805FFB8\\",\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"CloneVoices\\": [\\n {\\n \\"CloneVoiceId\\": \\"af81a389-91f0-4157-8d82-720edd02b66b\\",\\n \\"CreatedTime\\": 1764900994000,\\n \\"UpdatedTime\\": 1764900994000,\\n \\"InstanceId\\": \\"af81a389-91f0-4157-8d82-720edd02b66a\\",\\n \\"TenantId\\": \\"1308144684576655\\",\\n \\"Voice\\": \\"cosyvoice-v3-plus-voicebot2-3666e4bbb2b94832ac4f4107b5804c34\\",\\n \\"Name\\": \\"测试克隆音\\",\\n \\"NlsEngine\\": \\"BAILIAN\\",\\n \\"Status\\": \\"Published\\",\\n \\"Model\\": \\"CosyVoice\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:ListCloneVoice',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ListCloneVoiceModels' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => 'The page number to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => 'The number of entries to return per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response object.',
'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The unique ID generated for the request.', 'type' => 'string', 'example' => '9DB8BA95-4513-54B9-9C67-A28909CFB4AD'],
'Code' => ['description' => 'The status code of the request. A value of "OK" indicates success.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The detailed message returned for the request. It provides more context about the status code.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'Data' => [
'description' => 'The paginated data.',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '66', 'title' => ''],
'CloneVoiceModels' => [
'description' => 'A list of clone voice models.',
'type' => 'array',
'items' => [
'description' => 'Contains the details of a clone voice model.',
'type' => 'object',
'properties' => [
'Name' => [
'description' => 'The model name.',
'enumValueTitles' => ['CosyVoice' => 'CosyVoice', 'QwenVc' => 'QwenVc'],
'type' => 'string',
'example' => 'CosyVoice',
'title' => '',
],
'DisplayName' => [
'description' => 'The display name of the model.',
'enumValueTitles' => ['CosyVoice' => 'CosyVoice', 'Qwen' => 'QwenVc'],
'type' => 'string',
'example' => 'CosyVoice',
'title' => '',
],
'Description' => ['description' => 'The description of the model.', 'type' => 'string', 'example' => '口音还原相似度高、韵律流畅', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'Params' => [
'description' => 'A list of dynamic error parameters.',
'type' => 'array',
'items' => ['description' => 'A parameter that provides context for the message.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Retrieve clone voice model list',
'summary' => 'Lists the available clone voice models.',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9DB8BA95-4513-54B9-9C67-A28909CFB4AD\\",\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 66,\\n \\"CloneVoiceModels\\": [\\n {\\n \\"Name\\": \\"CosyVoice\\",\\n \\"DisplayName\\": \\"CosyVoice\\",\\n \\"Description\\": \\"口音还原相似度高、韵律流畅\\"\\n }\\n ]\\n },\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:ListCloneVoiceModels',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ListHistoricalInstanceReport' => [
'summary' => 'Retrieve aggregated instance metrics',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => 'The number of the page to return. The maximum value is 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '2', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => 'The number of entries to return on each page. The maximum value is 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '20', 'example' => '10', 'title' => ''],
],
[
'name' => 'InstanceIds',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => 'A JSON array of instance IDs. The array can contain up to 100 IDs.',
'type' => 'array',
'items' => ['description' => 'An instance ID.', 'type' => 'string', 'required' => false, 'example' => '123-3-42zeaa6vgd0i3a41v5aibr', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'StartTime',
'in' => 'formData',
'schema' => ['description' => 'The start time for the query. The server rounds this value up to the next hour.', 'type' => 'integer', 'format' => 'int64', 'docRequired' => true, 'required' => true, 'example' => '1775044800000', 'title' => ''],
],
[
'name' => 'EndTime',
'in' => 'formData',
'schema' => ['description' => 'The end time for the query. The server rounds this value up to the next hour.', 'type' => 'integer', 'format' => 'int64', 'docRequired' => true, 'required' => true, 'example' => '1775131200000', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response object.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'ID of the request ', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '9DB8BA95-4513-54B9-9C67-A28909CFB4AD'],
'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''],
'Data' => [
'description' => 'The response data.',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
'List' => [
'description' => 'A list of historical reports for the instances.',
'type' => 'array',
'items' => [
'description' => 'A set of metrics for an instance.',
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => '38d5fb05092b469e86b6061ad7945437', 'title' => ''],
'UsedConcurrency' => ['description' => 'The peak number of concurrent calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '11', 'title' => ''],
'ConfiguredConcurrency' => ['description' => 'The most recent concurrency configuration.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''],
'CallsOffered' => ['description' => 'The number of offered calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'CallsHandled' => ['description' => 'The number of answered calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '7', 'title' => ''],
'CallsRejected' => ['description' => 'The number of rejected calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''],
'CallsResolved' => ['description' => 'The number of calls classified as resolved by the large language model (LLM).', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''],
'TotalInputTokens' => ['description' => 'Reserved for future use.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'TotalOutputTokens' => ['description' => 'Reserved for future use.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'TotalTokens' => ['description' => 'Reserved for future use.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'TotalTalkTime' => ['description' => 'The total talk time in milliseconds (ms).', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
'MaxTalkTime' => ['description' => 'The maximum talk time in milliseconds (ms).', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
'RejectionBreakdown' => ['description' => 'The breakdown of rejection reasons.', 'type' => 'string', 'example' => '{'."\n"
.' "ConcurrentLimitExceeded":3'."\n"
.'}', 'title' => ''],
'ReleaseReasonBreakdown' => ['description' => 'A breakdown of release reasons for answered calls.', 'type' => 'string', 'example' => '{'."\n"
.' "SilenceTimeout":1,'."\n"
.' "TurnsLimitExceeded":1,'."\n"
.' "Exception":1,'."\n"
.' "Transferred":1,'."\n"
.' "Normal":1'."\n"
.'}', 'title' => ''],
'LabelBreakdown' => ['description' => 'The breakdown of labels.', 'type' => 'string', 'example' => '{'."\n"
.' "label1":{ '."\n"
.' "label1_sub1":10,'."\n"
.' "label1_sub2":2'."\n"
.'}'."\n"
.'}', 'title' => ''],
'TalkTurnsDistribution' => ['description' => 'The distribution of conversation turns.', 'type' => 'string', 'example' => '{'."\n"
.' "1":2,'."\n"
.' "10":3'."\n"
.'}', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'Params' => [
'description' => 'The list of error parameters.',
'type' => 'array',
'items' => ['description' => 'A dynamic error parameter.', 'type' => 'string', 'example' => '-', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Retrieve instance metric summary data',
'description' => '## Request'."\n"
."\n"
.'- This API retrieves the script configuration for a specific scenario, including settings for ASR, TTS, and dialogue capability.'."\n"
."\n"
.'- This request requires no parameters. The response includes the configuration data for both the draft and published versions.'."\n"
."\n"
.'- The configuration data is returned in the `Data` field of the response.',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9DB8BA95-4513-54B9-9C67-A28909CFB4AD\\",\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\n \\"List\\": [\\n {\\n \\"InstanceId\\": \\"38d5fb05092b469e86b6061ad7945437\\",\\n \\"UsedConcurrency\\": 11,\\n \\"ConfiguredConcurrency\\": 2,\\n \\"CallsOffered\\": 10,\\n \\"CallsHandled\\": 7,\\n \\"CallsRejected\\": 3,\\n \\"CallsResolved\\": 4,\\n \\"TotalInputTokens\\": 0,\\n \\"TotalOutputTokens\\": 0,\\n \\"TotalTokens\\": 0,\\n \\"TotalTalkTime\\": 100,\\n \\"MaxTalkTime\\": 20,\\n \\"RejectionBreakdown\\": \\"{\\\\n \\\\\\"ConcurrentLimitExceeded\\\\\\":3\\\\n}\\",\\n \\"ReleaseReasonBreakdown\\": \\"{\\\\n \\\\\\"SilenceTimeout\\\\\\":1,\\\\n \\\\\\"TurnsLimitExceeded\\\\\\":1,\\\\n \\\\\\"Exception\\\\\\":1,\\\\n \\\\\\"Transferred\\\\\\":1,\\\\n \\\\\\"Normal\\\\\\":1\\\\n}\\",\\n \\"LabelBreakdown\\": \\"{\\\\n \\\\\\"label1\\\\\\":{ \\\\n \\\\\\"label1_sub1\\\\\\":10,\\\\n \\\\\\"label1_sub2\\\\\\":2\\\\n}\\\\n}\\",\\n \\"TalkTurnsDistribution\\": \\"{\\\\n \\\\\\"1\\\\\\":2,\\\\n \\\\\\"10\\\\\\":3\\\\n}\\"\\n }\\n ]\\n },\\n \\"Params\\": [\\n \\"-\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:ListHistoricalInstanceReport',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ListHistoricalScriptReport' => [
'summary' => 'Get scene metric summary data',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => 'The page number to retrieve.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '20', 'example' => '10', 'title' => ''],
],
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the Voice Bot instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '12f407b22cbe4890ac595f09985848d5', 'title' => ''],
],
[
'name' => 'ScriptIds',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => 'A list of up to 100 script IDs.',
'type' => 'array',
'items' => ['description' => 'A script ID.', 'type' => 'string', 'required' => false, 'example' => '[]', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'StartTime',
'in' => 'formData',
'schema' => ['description' => 'The start of the query time range, which is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1582267398628', 'title' => ''],
],
[
'name' => 'EndTime',
'in' => 'formData',
'schema' => ['description' => 'The end of the query time range, which is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1582103299434', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The schema of the response.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'ID of the request ', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '9ab43460-c0b9-40e2-8447-48d82c97fc67'],
'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'Data' => [
'description' => 'The cloned voice ID.',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
'List' => [
'description' => 'A list of script reports.',
'type' => 'array',
'items' => [
'description' => 'Statistical data for a single script.',
'type' => 'object',
'properties' => [
'ScriptId' => ['description' => 'The script ID.', 'type' => 'string', 'example' => '891264b9-5883-4068-94a6-241ceb8d51e4', 'title' => ''],
'UsedConcurrency' => ['description' => 'The peak concurrency.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''],
'ConfiguredConcurrency' => ['description' => 'The most recent concurrency setting.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''],
'CallsOffered' => ['description' => 'The number of calls offered.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'CallsHandled' => ['description' => 'The number of calls handled.', 'type' => 'integer', 'format' => 'int64', 'example' => '7', 'title' => ''],
'CallsRejected' => ['description' => 'The number of calls rejected.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''],
'CallsResolved' => ['description' => 'The number of calls that a large language model (LLM) determined to be resolved.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''],
'TotalInputTokens' => ['description' => 'This parameter is reserved for future use.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'TotalOutputTokens' => ['description' => 'This parameter is reserved for future use.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'TotalTokens' => ['description' => 'This parameter is reserved for future use.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'TotalTalkTime' => ['description' => 'The total talk time, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
'MaxTalkTime' => ['description' => 'The maximum talk time, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''],
'RejectionBreakdown' => ['description' => 'A breakdown of call rejection reasons.', 'type' => 'string', 'example' => '{'."\n"
.' "ConcurrentLimitExceeded":3'."\n"
.'}', 'title' => ''],
'ReleaseReasonBreakdown' => ['description' => 'A breakdown of disconnection reasons for answered calls.', 'type' => 'string', 'example' => '{'."\n"
.' "SilenceTimeout":1,'."\n"
.' "TurnsLimitExceeded":1,'."\n"
.' "Exception":1,'."\n"
.' "Transferred":1,'."\n"
.' "Normal":1'."\n"
.'}', 'title' => ''],
'LabelDistribution' => ['description' => 'A breakdown of call labels.', 'type' => 'string', 'example' => '{'."\n"
.' "1":2,'."\n"
.' "10":3'."\n"
.'}', 'title' => ''],
'TalkTurnsDistribution' => ['description' => 'A breakdown of conversation turns.', 'type' => 'string', 'example' => '{'."\n"
.' "1":2,'."\n"
.' "10":3'."\n"
.'}'."\n", 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'Params' => [
'description' => 'A list of invalid parameters.',
'type' => 'array',
'items' => ['description' => 'The invalid dynamic parameter.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Retrieve aggregated metric data for scenarios. ',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9ab43460-c0b9-40e2-8447-48d82c97fc67\\",\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\n \\"List\\": [\\n {\\n \\"ScriptId\\": \\"891264b9-5883-4068-94a6-241ceb8d51e4\\",\\n \\"UsedConcurrency\\": 2,\\n \\"ConfiguredConcurrency\\": 3,\\n \\"CallsOffered\\": 10,\\n \\"CallsHandled\\": 7,\\n \\"CallsRejected\\": 3,\\n \\"CallsResolved\\": 4,\\n \\"TotalInputTokens\\": 0,\\n \\"TotalOutputTokens\\": 0,\\n \\"TotalTokens\\": 0,\\n \\"TotalTalkTime\\": 100,\\n \\"MaxTalkTime\\": 30,\\n \\"RejectionBreakdown\\": \\"{\\\\n \\\\\\"ConcurrentLimitExceeded\\\\\\":3\\\\n}\\",\\n \\"ReleaseReasonBreakdown\\": \\"{\\\\n \\\\\\"SilenceTimeout\\\\\\":1,\\\\n \\\\\\"TurnsLimitExceeded\\\\\\":1,\\\\n \\\\\\"Exception\\\\\\":1,\\\\n \\\\\\"Transferred\\\\\\":1,\\\\n \\\\\\"Normal\\\\\\":1\\\\n}\\",\\n \\"LabelDistribution\\": \\"{\\\\n \\\\\\"1\\\\\\":2,\\\\n \\\\\\"10\\\\\\":3\\\\n}\\",\\n \\"TalkTurnsDistribution\\": \\"{\\\\n \\\\\\"1\\\\\\":2,\\\\n \\\\\\"10\\\\\\":3\\\\n}\\\\n\\"\\n }\\n ]\\n },\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:ListHistoricalScriptReport',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ListInstructions' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'maxLength' => 64, 'example' => '36e9a4cd-a821-4f78-86fa-a9a4aefeea2e', 'title' => ''],
],
[
'name' => 'ProviderId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the call center provider.'."\n"
."\n"
.'> You can obtain this ID by calling the `ListCallCenterProviders` operation.', 'type' => 'string', 'required' => false, 'example' => '********', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'minimum' => '1', 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response schema.',
'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'e48e45dd-e47a-4744-a063-f08cbebb1c5a'],
'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The result message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'Data' => [
'description' => 'The data returned for the list of instructions.',
'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 instructions.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'Instructions' => [
'description' => 'The list of instructions.',
'type' => 'array',
'items' => [
'description' => 'An instruction.',
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => '36e9a4cd-a821-4f78-86fa-a9a4aefeea2e', 'title' => ''],
'Type' => [
'description' => 'The instruction type.',
'enumValueTitles' => ['TRANSFER' => 'transfer', 'GATHER_DTMF' => 'digit collection (DTMF)'],
'type' => 'string',
'example' => 'TRANSFER',
'title' => '',
],
'Code' => ['description' => 'The instruction code.', 'type' => 'string', 'example' => 'Transfer00', 'title' => ''],
'Name' => ['description' => 'The instruction name.', 'type' => 'string', 'example' => '转人工指令一', 'title' => ''],
'Config' => ['description' => 'The instruction configuration, in a JSON string format.'."\n"
."\n"
.'> - `providerId`: The ID of the call center provider. You can obtain this ID by calling the `ListCallCenterProviders` operation.'."\n"
.'>'."\n"
.'> - `transferMethod`: The transfer method. Valid values: `BYE`, `BRIDGE`, and `REFER`.'."\n"
.'>'."\n"
.'> - `transferType`: The transfer target type. Valid values: `External` (external number), `Agent` (agent), and `SkillGroup` (skill group).'."\n"
.'>'."\n"
.'> - `transferTarget`: The transfer target.'."\n"
.'>'."\n"
.'> - `transferor`: The caller ID. If not specified, the caller\'s phone number is used.'."\n"
.'>'."\n"
.'> - `timeoutSeconds`: The transfer timeout, in seconds. The default value is 30.', 'type' => 'string', 'example' => '{'."\n"
.' "providerId": "xxxxxxxxx",'."\n"
.' "transferMethod": "BYE",'."\n"
.' "transferType": "External",'."\n"
.' "transferTarget": "152******",'."\n"
.' "transferor": "01*****",'."\n"
.' "timeoutSeconds": "10"'."\n"
.'}', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'Params' => [
'description' => 'A list of request parameters that are echoed in the response.',
'type' => 'array',
'items' => ['description' => 'A request parameter that is echoed in the response.', 'type' => 'string', 'example' => '36e9a4cd-a821-4f78-86fa-a9a4aefeea2e', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'List query instructions',
'summary' => 'Lists the instructions that are configured for a Digital Employee.',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"e48e45dd-e47a-4744-a063-f08cbebb1c5a\\",\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Instructions\\": [\\n {\\n \\"InstanceId\\": \\"36e9a4cd-a821-4f78-86fa-a9a4aefeea2e\\",\\n \\"Type\\": \\"TRANSFER\\",\\n \\"Code\\": \\"Transfer00\\",\\n \\"Name\\": \\"转人工指令一\\",\\n \\"Config\\": \\"{\\\\n\\\\t\\\\\\"providerId\\\\\\": \\\\\\"xxxxxxxxx\\\\\\",\\\\n\\\\t\\\\\\"transferMethod\\\\\\": \\\\\\"BYE\\\\\\",\\\\n\\\\t\\\\\\"transferType\\\\\\": \\\\\\"External\\\\\\",\\\\n\\\\t\\\\\\"transferTarget\\\\\\": \\\\\\"152******\\\\\\",\\\\n\\\\t\\\\\\"transferor\\\\\\": \\\\\\"01*****\\\\\\",\\\\n\\\\t\\\\\\"timeoutSeconds\\\\\\": \\\\\\"10\\\\\\"\\\\n}\\"\\n }\\n ]\\n },\\n \\"Params\\": [\\n \\"36e9a4cd-a821-4f78-86fa-a9a4aefeea2e\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:ListInstructions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ListLlmAccessProfiles' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'example' => '12f407b22cbe4890ac595f09985848d5', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The schema of the response.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request ', 'description' => 'A unique identifier for the request.', 'type' => 'string', 'example' => 'ED56B723-5802-5C32-865F-6E20B06D2455'],
'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'Data' => [
'description' => 'The paginated list of third-party model configurations.',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'LlmAccessProfiles' => [
'description' => 'The list of third-party model configurations.',
'type' => 'array',
'items' => [
'description' => 'A third-party model configuration.',
'type' => 'object',
'properties' => [
'AccessProfileId' => ['description' => 'The configuration ID.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66b', 'title' => ''],
'CreatedTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1747620752000', 'title' => ''],
'UpdatedTime' => ['description' => 'The update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1768788798', 'title' => ''],
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => '8fe2b8b1cdd446318610ccbc70bcfff0', 'title' => ''],
'Profile' => [
'description' => 'The parameter configuration.',
'type' => 'object',
'properties' => [
'Name' => ['description' => 'The name of the configuration.', 'type' => 'string', 'example' => '千问Omni', 'title' => ''],
'ApiKey' => ['description' => 'The API key.', 'type' => 'string', 'example' => 'akm-93929110-d7c1-4014-8678-613aacd58fa2', 'title' => ''],
'NluAccessType' => [
'description' => 'The NLU access type.',
'enumValueTitles' => ['PROVIDED' => 'PROVIDED', 'MANAGED' => 'MANAGED', 'AUTHORIZED' => 'AUTHORIZED'],
'type' => 'string',
'example' => 'MANAGED',
'title' => '',
],
'NluEngine' => [
'description' => 'The NLU engine.',
'enumValueTitles' => ['PROMPTS' => 'PROMPTS', 'BEEBOT' => 'BEEBOT', 'FUNCTION' => 'FUNCTION'],
'type' => 'string',
'example' => 'BEEBOT',
'title' => '',
],
'Endpoint' => ['description' => 'The service endpoint.', 'type' => 'string', 'example' => 'api.llm.enpoint.example.com', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'Params' => [
'description' => 'A list of dynamic parameters associated with the error.',
'type' => 'array',
'items' => ['description' => 'A dynamic parameter associated with the error.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Obtain third-party model configuration list ',
'summary' => 'Get the language model configuration.',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ED56B723-5802-5C32-865F-6E20B06D2455\\",\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"LlmAccessProfiles\\": [\\n {\\n \\"AccessProfileId\\": \\"af81a389-91f0-4157-8d82-720edd02b66b\\",\\n \\"CreatedTime\\": 1747620752000,\\n \\"UpdatedTime\\": 1768788798,\\n \\"InstanceId\\": \\"8fe2b8b1cdd446318610ccbc70bcfff0\\",\\n \\"Profile\\": {\\n \\"Name\\": \\"千问Omni\\",\\n \\"ApiKey\\": \\"akm-93929110-d7c1-4014-8678-613aacd58fa2\\",\\n \\"NluAccessType\\": \\"MANAGED\\",\\n \\"NluEngine\\": \\"BEEBOT\\",\\n \\"Endpoint\\": \\"api.llm.enpoint.example.com\\"\\n }\\n }\\n ]\\n },\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:ListLlmAccessProfiles',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ListNluModels' => [
'summary' => 'Lists the available NLU models.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response schema.',
'title' => '',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '7401D698-0AAC-5909-B68E-88C68805FFB8'],
'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'Data' => [
'description' => 'A list of the NLU models.',
'type' => 'array',
'items' => [
'description' => 'An NLU model from the list.',
'type' => 'object',
'properties' => [
'Id' => [
'description' => 'The model ID.',
'enumValueTitles' => ['qwen-plus' => 'qwen-plus', 'qwen-turbo' => 'qwen-turbo', 'qwen3-omni-flash-realtime' => 'qwen-omni', 'qwen-max' => 'qwen-max'],
'type' => 'string',
'example' => 'qwen-plus',
'title' => '',
],
'Name' => [
'description' => 'The model name.',
'enumValueTitles' => ['通义千问-Turbo' => '', '通义千问-Plus' => '', '通义千问-Omni' => '', '通义千问-Max' => ''],
'type' => 'string',
'example' => '千问-Plus',
'title' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'Params' => [
'description' => 'The dynamic parameters for the error.',
'type' => 'array',
'items' => ['description' => 'A parameter value that contributed to the error.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Retrieve the Large Language Model (LLM) List ',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:ListNluModels',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7401D698-0AAC-5909-B68E-88C68805FFB8\\",\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": \\"qwen-plus\\",\\n \\"Name\\": \\"千问-Plus\\"\\n }\\n ],\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
],
'ListRealtimeInstanceStats' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '2', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '20', 'example' => '10', 'title' => ''],
],
[
'name' => 'InstanceIds',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => 'A list of 1 to 100 instance IDs.',
'type' => 'array',
'items' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'dxxx-1234-d-ddxxaeftjh-xxxakegh', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response object.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'ID of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9DB8BA95-4513-54B9-9C67-A28909CFB4AD'],
'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'Data' => [
'description' => 'The paginated list of real-time instance statistics.',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
'List' => [
'description' => 'A list of real-time instance statistics.',
'type' => 'array',
'items' => [
'description' => 'Real-time statistics for an instance.',
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => '88b64330a8d34e63b60c9d272f8b3950', 'title' => ''],
'StatsTime' => ['description' => 'The time when the statistics were collected, represented as a millisecond-level UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1776837256000', 'title' => ''],
'UsedConcurrency' => ['description' => 'The number of active concurrent calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'ConfiguredConcurrency' => ['description' => 'The maximum number of concurrent calls allowed for the instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'Params' => [
'description' => 'A list of invalid parameters.',
'type' => 'array',
'items' => ['description' => 'An invalid parameter.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Obtain real-time instance statistics. ',
'summary' => 'Retrieves real-time statistics for one or more instances.',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9DB8BA95-4513-54B9-9C67-A28909CFB4AD\\",\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\n \\"List\\": [\\n {\\n \\"InstanceId\\": \\"88b64330a8d34e63b60c9d272f8b3950\\",\\n \\"StatsTime\\": 1776837256000,\\n \\"UsedConcurrency\\": 10,\\n \\"ConfiguredConcurrency\\": 12\\n }\\n ]\\n },\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:ListRealtimeInstanceStats',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ListScriptProfileTemplates' => [
'summary' => 'Lists the scenario configuration templates.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'c28fc549-d88f-4f6e-85ad-a0806e5e39c0', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response object.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E6E61E1A-D2DC-5ACF-AED4-A115B6691F98'],
'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'Data' => [
'description' => 'The list of scenario templates.',
'type' => 'array',
'items' => [
'description' => 'A scenario template object.',
'type' => 'object',
'properties' => [
'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => 'CCC_PROMPTS_DEFAULT', 'title' => ''],
'CreatedTime' => ['description' => 'The time the template was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1752829090000', 'title' => ''],
'UpdatedTime' => ['description' => 'The time the template was last updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1752829090000', 'title' => ''],
'Name' => ['description' => 'The name of the template.', 'type' => 'string', 'example' => '通用场景', 'title' => ''],
'Description' => ['description' => 'The description of the template.', 'type' => 'string', 'example' => '从空白文档开始构建专业版对话提示词工程。', 'title' => ''],
'Schema' => ['description' => 'The template definition.', 'type' => 'string', 'example' => '{'."\n"
.' "name": "General",'."\n"
.' "properties": {'."\n"
.' "prompts": {'."\n"
.' "displayName": "指令信息",'."\n"
.' "dataType": "TEXT",'."\n"
.' "name": "prompts",'."\n"
.' "displayOrder": 1,'."\n"
.' "defaultValue": "你是一名亲切友好的聊天助手，专注中文自然对话。保持积极耐心，提供有益回应，避免敏感内容。未知问题请诚恳说明，营造轻松愉快的交流体验。",'."\n"
.' "attributes": {'."\n"
.' "placeholder": "你是一名亲切友好的聊天助手，专注中文自然对话。保持积极耐心，提供有益回应，避免敏感内容。未知问题请诚恳说明，营造轻松愉快的交流体验。",'."\n"
.' "rows": 20'."\n"
.' },'."\n"
.' "editorType": "MENTIONS_TEXTAREA",'."\n"
.' "maxLength": 2000,'."\n"
.' "required": true,'."\n"
.' "group": "业务描述"'."\n"
.' }'."\n"
.' }'."\n"
.'}', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'Params' => [
'description' => 'A list of invalid parameters.',
'type' => 'array',
'items' => ['description' => 'An invalid parameter.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Retrieve the prompt scenario template List ',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E6E61E1A-D2DC-5ACF-AED4-A115B6691F98\\",\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"Data\\": [\\n {\\n \\"TemplateId\\": \\"CCC_PROMPTS_DEFAULT\\",\\n \\"CreatedTime\\": 1752829090000,\\n \\"UpdatedTime\\": 1752829090000,\\n \\"Name\\": \\"通用场景\\",\\n \\"Description\\": \\"从空白文档开始构建专业版对话提示词工程。\\",\\n \\"Schema\\": \\"{\\\\n \\\\\\"name\\\\\\": \\\\\\"General\\\\\\",\\\\n \\\\\\"properties\\\\\\": {\\\\n \\\\\\"prompts\\\\\\": {\\\\n \\\\\\"displayName\\\\\\": \\\\\\"指令信息\\\\\\",\\\\n \\\\\\"dataType\\\\\\": \\\\\\"TEXT\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"prompts\\\\\\",\\\\n \\\\\\"displayOrder\\\\\\": 1,\\\\n \\\\\\"defaultValue\\\\\\": \\\\\\"你是一名亲切友好的聊天助手，专注中文自然对话。保持积极耐心，提供有益回应，避免敏感内容。未知问题请诚恳说明，营造轻松愉快的交流体验。\\\\\\",\\\\n \\\\\\"attributes\\\\\\": {\\\\n \\\\\\"placeholder\\\\\\": \\\\\\"你是一名亲切友好的聊天助手，专注中文自然对话。保持积极耐心，提供有益回应，避免敏感内容。未知问题请诚恳说明，营造轻松愉快的交流体验。\\\\\\",\\\\n \\\\\\"rows\\\\\\": 20\\\\n },\\\\n \\\\\\"editorType\\\\\\": \\\\\\"MENTIONS_TEXTAREA\\\\\\",\\\\n \\\\\\"maxLength\\\\\\": 2000,\\\\n \\\\\\"required\\\\\\": true,\\\\n \\\\\\"group\\\\\\": \\\\\\"业务描述\\\\\\"\\\\n }\\\\n }\\\\n}\\"\\n }\\n ],\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:ListScriptProfileTemplates',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ListScripts' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the Voice Navigator instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => 'The name of the script.', 'type' => 'string', 'required' => false, 'example' => '导航测试场景', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '10', 'title' => ''],
],
[
'name' => 'Status',
'in' => 'formData',
'schema' => [
'description' => 'The status of the script.',
'enumValueTitles' => ['PUBLISHED' => 'The script is published.', 'DRAFT' => 'The script is a draft.', 'PUBLISHED_DRAFT' => 'The script is published and has a draft version.'],
'type' => 'string',
'required' => false,
'example' => 'DRAFT',
'title' => '',
],
],
[
'name' => 'Number',
'in' => 'formData',
'schema' => ['description' => 'The phone number.', 'type' => 'string', 'required' => false, 'example' => '13816111993', 'title' => ''],
],
[
'name' => 'ScriptIds',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => 'A list of script IDs.',
'type' => 'array',
'items' => ['description' => 'A script ID.', 'type' => 'string', 'required' => false, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response object.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'BA092E9B-3421-5862-BC75-E646B7587531'],
'Code' => ['description' => 'The API-specific status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'Data' => [
'description' => 'The paginated list of scripts.',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries to return per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'TotalCount' => ['description' => 'The total number of scripts.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
'Scripts' => [
'description' => 'The list of scripts.',
'type' => 'array',
'items' => [
'description' => 'A script object.',
'type' => 'object',
'properties' => [
'ScriptId' => ['description' => 'The script ID.', 'type' => 'string', 'example' => 'efbafa38-336d-4eb0-865e-c16c97a91772', 'title' => ''],
'CreatedTime' => ['description' => 'The creation time. This is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1773228988000', 'title' => ''],
'UpdatedTime' => ['description' => 'The update time. This is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1773228988000', 'title' => ''],
'Name' => ['description' => 'The script name.', 'type' => 'string', 'example' => '导航测试场景', 'title' => ''],
'Description' => ['description' => 'The script description.', 'type' => 'string', 'example' => '用于测试', 'title' => ''],
'Concurrency' => ['description' => 'The maximum number of concurrent calls for the script.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'NluEngine' => ['description' => 'The NLU engine.', 'type' => 'string', 'example' => 'BEEBOT', 'title' => ''],
'NluAccessType' => ['description' => 'The NLU access type.', 'type' => 'string', 'example' => 'MANAGED', 'title' => ''],
'DraftVersionId' => ['description' => 'The draft version ID.', 'type' => 'string', 'example' => 'efbafa38-336d-4eb0-865e-c16c97a91773', 'title' => ''],
'PublishedVersionId' => ['description' => 'The published version ID.', 'type' => 'string', 'example' => 'efbafa38-336d-4eb0-865e-c16c97a91774', 'title' => ''],
'Status' => ['description' => 'The status of the script.', 'type' => 'string', 'example' => 'DRAFT', 'title' => ''],
'Number' => ['description' => 'The phone number for the script.', 'type' => 'string', 'example' => '13816111993', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'Params' => [
'description' => 'Dynamic error parameters.',
'type' => 'array',
'items' => ['description' => 'A dynamic error parameter.', 'type' => 'string', 'example' => 'efbafa38-336d-4eb0-865e-c16c97a91775', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Retrieve scenario list ',
'summary' => 'Get instance details',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BA092E9B-3421-5862-BC75-E646B7587531\\",\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 30,\\n \\"Scripts\\": [\\n {\\n \\"ScriptId\\": \\"efbafa38-336d-4eb0-865e-c16c97a91772\\",\\n \\"CreatedTime\\": 1773228988000,\\n \\"UpdatedTime\\": 1773228988000,\\n \\"Name\\": \\"导航测试场景\\",\\n \\"Description\\": \\"用于测试\\",\\n \\"Concurrency\\": 10,\\n \\"NluEngine\\": \\"BEEBOT\\",\\n \\"NluAccessType\\": \\"MANAGED\\",\\n \\"DraftVersionId\\": \\"efbafa38-336d-4eb0-865e-c16c97a91773\\",\\n \\"PublishedVersionId\\": \\"efbafa38-336d-4eb0-865e-c16c97a91774\\",\\n \\"Status\\": \\"DRAFT\\",\\n \\"Number\\": \\"13816111993\\"\\n }\\n ]\\n },\\n \\"Params\\": [\\n \\"efbafa38-336d-4eb0-865e-c16c97a91775\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:ListScripts',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ListVariable' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'c28fc549-d88f-4f6e-85ad-a0806e5e39c0', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '10', 'title' => ''],
],
[
'name' => 'SearchPattern',
'in' => 'formData',
'schema' => ['description' => 'A keyword for a fuzzy search by variable name or display name.', 'type' => 'string', 'required' => false, 'example' => 'age', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response object.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'd74d6290-7cbe-4436-b5d7-014ebb0f4060'],
'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'Data' => [
'description' => 'The paginated data for the list of variables.',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'Variables' => [
'description' => 'A list of variable objects.',
'type' => 'array',
'items' => [
'description' => 'A variable object.',
'type' => 'object',
'properties' => [
'VariableId' => ['description' => 'The variable ID.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66b', 'title' => ''],
'CreatedTime' => ['description' => 'The time when the variable was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1754013825102', 'title' => ''],
'UpdatedTime' => ['description' => 'The time when the variable was last updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1754013825102', 'title' => ''],
'Name' => ['description' => 'The name of the variable.', 'type' => 'string', 'example' => 'age', 'title' => ''],
'DisplayName' => ['description' => 'The display name.', 'type' => 'string', 'example' => '年龄', 'title' => ''],
'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => '用户当前年龄', 'title' => ''],
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66c', 'title' => ''],
'TenantId' => ['description' => 'The tenant ID.', 'type' => 'string', 'example' => '1308144684576655', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'Params' => [
'description' => 'A list of parameters for the error message.',
'type' => 'array',
'items' => ['description' => 'A parameter for the error message.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Retrieve variable list',
'summary' => 'Retrieves a list of variables.',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"d74d6290-7cbe-4436-b5d7-014ebb0f4060\\",\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Variables\\": [\\n {\\n \\"VariableId\\": \\"af81a389-91f0-4157-8d82-720edd02b66b\\",\\n \\"CreatedTime\\": 1754013825102,\\n \\"UpdatedTime\\": 1754013825102,\\n \\"Name\\": \\"age\\",\\n \\"DisplayName\\": \\"年龄\\",\\n \\"Description\\": \\"用户当前年龄\\",\\n \\"InstanceId\\": \\"af81a389-91f0-4157-8d82-720edd02b66c\\",\\n \\"TenantId\\": \\"1308144684576655\\"\\n }\\n ]\\n },\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:ListVariable',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ListVocabulary' => [
'summary' => 'Retrieves a list of vocabularies for a specified instance.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => 'The name of the vocabulary.', 'type' => 'string', 'required' => false, 'example' => '金融', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response data.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9DB8BA95-4513-54B9-9C67-A28909CFB4AD'],
'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'Data' => [
'description' => 'The paginated list of vocabularies.',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'Vocabularies' => [
'description' => 'A list of vocabularies.',
'type' => 'array',
'items' => [
'description' => 'A vocabulary.',
'type' => 'object',
'properties' => [
'VocabularyId' => ['description' => 'The ID of the vocabulary.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66b', 'title' => ''],
'CreatedTime' => ['description' => 'The time the vocabulary was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1754013825102', 'title' => ''],
'UpdatedTime' => ['description' => 'The time the vocabulary was last updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1754013825102', 'title' => ''],
'Name' => ['description' => 'The name of the vocabulary.', 'type' => 'string', 'example' => '金融场景热词', 'title' => ''],
'Description' => ['description' => 'The description of the vocabulary.', 'type' => 'string', 'example' => '包含金融场景专业术语', 'title' => ''],
'InstanceId' => ['description' => 'The ID of the instance.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'TenantId' => ['description' => 'The ID of the tenant.', 'type' => 'string', 'example' => '1308144684576655', 'title' => ''],
'WordCount' => ['description' => 'The number of words in the vocabulary.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'Params' => [
'description' => 'The list of dynamic error parameters.',
'type' => 'array',
'items' => ['description' => 'A dynamic error parameter.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Retrieve Hotword List',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9DB8BA95-4513-54B9-9C67-A28909CFB4AD\\",\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Vocabularies\\": [\\n {\\n \\"VocabularyId\\": \\"af81a389-91f0-4157-8d82-720edd02b66b\\",\\n \\"CreatedTime\\": 1754013825102,\\n \\"UpdatedTime\\": 1754013825102,\\n \\"Name\\": \\"金融场景热词\\",\\n \\"Description\\": \\"包含金融场景专业术语\\",\\n \\"InstanceId\\": \\"af81a389-91f0-4157-8d82-720edd02b66a\\",\\n \\"TenantId\\": \\"1308144684576655\\",\\n \\"WordCount\\": 50\\n }\\n ]\\n },\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:ListVocabulary',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ListVoiceAccessProfile' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The data returned.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'C1788610-93C9-574C-AF2D-C053A50C3894'],
'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'Data' => [
'description' => 'A paginated list of the third-party voice configurations.',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
'VoiceAccessProfiles' => [
'description' => 'The list of third-party voice configuration profiles.',
'type' => 'array',
'items' => [
'description' => 'A third-party voice configuration profile.',
'type' => 'object',
'properties' => [
'AccessProfileId' => ['description' => 'The ID of the configuration profile.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66b', 'title' => ''],
'CreatedTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1747620752000', 'title' => ''],
'UpdatedTime' => ['description' => 'The update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1747620752000', 'title' => ''],
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'NlsEngine' => [
'description' => 'The voice engine.',
'enumValueTitles' => ['IFLYTEK' => 'iFLYTEK', 'VOLC' => 'Doubao', 'BAILIAN' => 'Alibaba Cloud Model Studio'],
'type' => 'string',
'example' => 'VOLC',
'title' => '',
],
'NlsEngineName' => [
'description' => 'The display name of the voice engine.',
'enumValueTitles' => ['科大讯飞' => 'iFLYTEK', '阿里云百炼' => 'Alibaba Cloud Model Studio', '豆包' => 'Doubao'],
'type' => 'string',
'example' => '豆包',
'title' => '',
],
'Profile' => [
'description' => 'The credential configuration for the third-party voice engine.',
'type' => 'object',
'properties' => [
'AppId' => ['description' => 'The app ID required to call iFLYTEK services.', 'type' => 'string', 'example' => '5b123bfb', 'title' => ''],
'ApiKey' => ['description' => 'The API key required for calling Alibaba Cloud Model Studio or iFLYTEK services.', 'type' => 'string', 'example' => 'sk-12341e259b1049e8872b47981e545f78', 'title' => ''],
'ApiSecret' => ['description' => 'The API secret required for calling iFLYTEK services.', 'type' => 'string', 'example' => 'c0358c6e51c1013b446fdeb21a3a1234', 'title' => ''],
'AppKey' => ['description' => 'The app key required to call Doubao services.', 'type' => 'string', 'example' => '2541370123', 'title' => ''],
'AccessKey' => ['description' => 'The access key required for calling Doubao services.', 'type' => 'string', 'example' => 'HwRnTXgwnQOlsj68URDS5_VMm4Wtapq9', 'title' => ''],
'AsrAppKey' => ['description' => 'This parameter is not currently used.', 'type' => 'string', 'example' => '暂无使用', 'title' => ''],
'TtsApiKey' => ['description' => 'This parameter is not currently used.', 'type' => 'string', 'example' => '暂无使用', 'title' => ''],
],
'title' => '',
'example' => '',
],
'Capabilities' => [
'description' => 'The capabilities of the voice engine.',
'type' => 'array',
'items' => [
'description' => 'A capability supported by the voice engine.',
'enumValueTitles' => ['ASR' => 'Automatic Speech Recognition', 'TTS' => 'Text-to-Speech'],
'type' => 'string',
'example' => 'ASR',
'title' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'Params' => [
'description' => 'Dynamic parameters for the error message.',
'type' => 'array',
'items' => ['description' => 'A dynamic parameter for the error message.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Obtain third-party voice configuration list ',
'summary' => 'Get instance details',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C1788610-93C9-574C-AF2D-C053A50C3894\\",\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\n \\"VoiceAccessProfiles\\": [\\n {\\n \\"AccessProfileId\\": \\"af81a389-91f0-4157-8d82-720edd02b66b\\",\\n \\"CreatedTime\\": 1747620752000,\\n \\"UpdatedTime\\": 1747620752000,\\n \\"InstanceId\\": \\"af81a389-91f0-4157-8d82-720edd02b66a\\",\\n \\"NlsEngine\\": \\"VOLC\\",\\n \\"NlsEngineName\\": \\"豆包\\",\\n \\"Profile\\": {\\n \\"AppId\\": \\"5b123bfb\\",\\n \\"ApiKey\\": \\"sk-12341e259b1049e8872b47981e545f78\\",\\n \\"ApiSecret\\": \\"c0358c6e51c1013b446fdeb21a3a1234\\",\\n \\"AppKey\\": \\"2541370123\\",\\n \\"AccessKey\\": \\"HwRnTXgwnQOlsj68URDS5_VMm4Wtapq9\\",\\n \\"AsrAppKey\\": \\"暂无使用\\",\\n \\"TtsApiKey\\": \\"暂无使用\\"\\n },\\n \\"Capabilities\\": [\\n \\"ASR\\"\\n ]\\n }\\n ]\\n },\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:ListVoiceAccessProfile',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ListVoiceEngines' => [
'summary' => 'Lists available voice engines.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The data returned.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7401D698-0AAC-5909-B68E-88C68805FFB8'],
'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'Data' => [
'description' => 'The paginated list of voice engines.',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'TotalCount' => ['description' => 'The total number of voice engines.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
'VoiceEngines' => [
'description' => 'A list of voice engines.',
'type' => 'array',
'items' => [
'description' => 'A voice engine.',
'type' => 'object',
'properties' => [
'NlsEngine' => [
'description' => 'The voice engine.',
'enumValueTitles' => ['IFLYTEK' => 'iFLYTEK', 'VOLC' => 'VOLC', 'BAILIAN' => 'Model Studio'],
'type' => 'string',
'example' => 'VOLC',
'title' => '',
],
'NlsEngineName' => [
'description' => 'The display name.',
'enumValueTitles' => ['科大讯飞' => 'iFLYTEK', '阿里云百炼' => 'Alibaba Cloud Model Studio', '豆包' => 'Doubao'],
'type' => 'string',
'example' => '豆包',
'title' => '',
],
'ConfigSchema' => ['description' => 'The engine configuration in JSON format.', 'type' => 'string', 'example' => '[{\\"displayName\\":\\"AppKey\\",\\"maxLength\\":64,\\"name\\":\\"AppKey\\",\\"order\\":1,\\"required\\":true},{\\"displayName\\":\\"AccessKey\\",\\"maxLength\\":64,\\"name\\":\\"AccessKey\\",\\"order\\":2,\\"required\\":true}]', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'Params' => [
'description' => 'A list of dynamic error parameters.',
'type' => 'array',
'items' => ['description' => 'A dynamic error parameter.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Obtain third-party voice engine list ',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7401D698-0AAC-5909-B68E-88C68805FFB8\\",\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\n \\"VoiceEngines\\": [\\n {\\n \\"NlsEngine\\": \\"VOLC\\",\\n \\"NlsEngineName\\": \\"豆包\\",\\n \\"ConfigSchema\\": \\"[{\\\\\\\\\\\\\\"displayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"AppKey\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"maxLength\\\\\\\\\\\\\\":64,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"AppKey\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"order\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"required\\\\\\\\\\\\\\":true},{\\\\\\\\\\\\\\"displayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"AccessKey\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"maxLength\\\\\\\\\\\\\\":64,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"AccessKey\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"order\\\\\\\\\\\\\\":2,\\\\\\\\\\\\\\"required\\\\\\\\\\\\\\":true}]\\"\\n }\\n ]\\n },\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:ListVoiceEngines',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ListVoices' => [
'summary' => 'Retrieves a list of available voices.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'e48e45dd-e47a-4744-a063-f08cbebb1c5a', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '10', 'title' => ''],
],
[
'name' => 'NlsAccessType',
'in' => 'formData',
'schema' => [
'description' => 'The TTS access type.',
'enumValueTitles' => ['PROVIDED' => 'Uses a custom third-party configuration.', 'MANAGED' => 'Uses the system\'s managed configuration.'],
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'MANAGED',
'title' => '',
],
],
[
'name' => 'NlsEngine',
'in' => 'formData',
'schema' => [
'description' => 'The TTS engine.',
'enumValueTitles' => ['IFLYTEK' => 'IFLYTEK', 'VOLC' => 'VOLC', 'BAILIAN' => 'BAILIAN'],
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'BAILIAN',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response.',
'title' => '',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9DB8BA95-4513-54B9-9C67-A28909CFB4AD'],
'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'Data' => [
'description' => 'A paginated list of voices.',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'TotalCount' => ['description' => 'The total count of voices.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'Voices' => [
'description' => 'A list of voices.',
'type' => 'array',
'items' => [
'description' => 'A voice object.',
'type' => 'object',
'properties' => [
'Category' => ['description' => 'The category of the voice.', 'type' => 'string', 'example' => '千问音色', 'title' => ''],
'Name' => ['description' => 'The name of the voice.', 'type' => 'string', 'example' => '芊悦', 'title' => ''],
'Style' => ['description' => 'The style of the voice.', 'type' => 'string', 'example' => '女声', 'title' => ''],
'Voice' => ['description' => 'The identifier for the voice.', 'type' => 'string', 'example' => 'Cherry', 'title' => ''],
'Language' => ['description' => 'The language supported by the voice.', 'type' => 'string', 'example' => '中文及中英文混合', 'title' => ''],
'NlsEngine' => ['description' => 'The TTS engine.', 'type' => 'string', 'example' => 'BAILIAN', 'title' => ''],
'Model' => ['description' => 'The TTS model.', 'type' => 'string', 'example' => 'Qwen', 'title' => ''],
'SupportedParams' => [
'description' => 'A list of supported parameters.',
'type' => 'array',
'items' => ['description' => 'A supported parameter.', 'type' => 'string', 'example' => 'speechRate', 'title' => ''],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'Params' => [
'description' => 'A list of dynamic parameters related to the error.',
'type' => 'array',
'items' => ['description' => 'A dynamic parameter related to the error.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Retrieve voice list',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:ListVoices',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9DB8BA95-4513-54B9-9C67-A28909CFB4AD\\",\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Voices\\": [\\n {\\n \\"Category\\": \\"千问音色\\",\\n \\"Name\\": \\"芊悦\\",\\n \\"Style\\": \\"女声\\",\\n \\"Voice\\": \\"Cherry\\",\\n \\"Language\\": \\"中文及中英文混合\\",\\n \\"NlsEngine\\": \\"BAILIAN\\",\\n \\"Model\\": \\"Qwen\\",\\n \\"SupportedParams\\": [\\n \\"speechRate\\"\\n ]\\n }\\n ]\\n },\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
'translator' => 'machine',
],
'PreviewVoice' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'da37319b-6c83-4268-9f19-814aed62e401', 'title' => ''],
],
[
'name' => 'NlsEngine',
'in' => 'formData',
'schema' => [
'description' => 'The TTS engine.',
'enumValueTitles' => ['IFLYTEK' => 'IFLYTEK', 'VOLC' => 'VOLC', 'BAILIAN' => 'BAILIAN'],
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'BAILIAN',
'title' => '',
],
],
[
'name' => 'NlsAccessType',
'in' => 'formData',
'schema' => [
'description' => 'The TTS invocation method.',
'enumValueTitles' => ['PROVIDED' => 'PROVIDED', 'MANAGED' => 'MANAGED'],
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'MANAGED',
'title' => '',
],
],
[
'name' => 'Model',
'in' => 'formData',
'schema' => ['description' => 'The TTS model.', 'type' => 'string', 'required' => false, 'example' => 'Qwen', 'title' => ''],
],
[
'name' => 'Voice',
'in' => 'formData',
'schema' => ['description' => 'The voice to use for synthesis.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'Cherry', 'title' => ''],
],
[
'name' => 'Text',
'in' => 'formData',
'schema' => ['description' => 'The preview text to synthesize.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '你好，很高兴认识你', 'title' => ''],
],
[
'name' => 'Params',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => 'The synthesis parameters.',
'type' => 'object',
'properties' => [
'SpeechRate' => ['description' => 'The speech rate.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0', 'title' => ''],
'Volume' => ['description' => 'The volume.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''],
'PitchRate' => ['description' => 'The pitch.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The data returned for the request.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request ', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC'],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Data' => ['description' => 'The preview audio URL.', 'type' => 'string', 'example' => 'https://cab-config-pre.oss-cn-hangzhou.aliyuncs.com/TTSDEMO/05B9FBF3-3681-10FF-9C24-340A93F3A25F.wav?Expires=1774795253&OSSAccessKeyId=STS.NYGg2ejEjYqySx3EsuRutagbd&Signature=L7oa%2F7s%2FeVwBxpkn3SvKfr8uXB0%3D&security-token=CAISzwJ1q6Ft5B2yfSjIr5ryLIjRh5pL7rOSUV6CoXMgXvpYjqLJhjz2IHhMfnlvB%2BgYsfU2m2xR5%2FYclrp6SJtIXleCZtF94oxN9h2gb4fb42Jqag%2B%2F08%2FLI3OaLjKm9u2wCryLYbGwU%2FOpbE%2B%2B5U0X6LDmdDKkckW4OJmS8%2FBOZcgWWQ%2FKBlgvRq0hRG1YpdQdKGHaONu0LxfumRCwNkdzvRdmgm4NgsbWgO%2Fks0GG3ASmlrFF%2B9mufMb5M%2FMBZskvD42Hu8VtbbfE3SJq7BxHybx7lqQs%2B02c5onHUwYPu0vZYrOLroQ%2BfFFjHKMzEetPq%2F7ylPI9ofDamIXxxAarin3kufQeLmrJ4LwneIvBXr5RHd5wa2rbWAEsmLNBEhL2EJMKtT476hcbIAuUI3bC5F%2BkxOHp9i6ErImtRWbLssUUla4R5TGOWbLJWzkTH93xuRqAAapuIRuRt0d2Odr1hsaYukMd42UkNapdTrehzmXeR6lyv1jlLmkAHve9Cbl9N5bO3A96FSlEfjHksQBWG0CEXRm3jLW41bpR00dgnM6gpOj7lRW2z33L0dTtaRw79X3%2BUqz3gv9md5QvoaVi1jnr%2FcFRNxbjl7DI39pdcGlTI2lqIAA%3D', 'title' => ''],
'Params' => [
'description' => 'A list of dynamic values used in the error message.',
'type' => 'array',
'items' => ['description' => 'A dynamic value from the error message.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'TTS Synthesis Preview ',
'summary' => 'Generates a preview of a voice.',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": \\"https://cab-config-pre.oss-cn-hangzhou.aliyuncs.com/TTSDEMO/05B9FBF3-3681-10FF-9C24-340A93F3A25F.wav?Expires=1774795253&OSSAccessKeyId=STS.NYGg2ejEjYqySx3EsuRutagbd&Signature=L7oa%2F7s%2FeVwBxpkn3SvKfr8uXB0%3D&security-token=CAISzwJ1q6Ft5B2yfSjIr5ryLIjRh5pL7rOSUV6CoXMgXvpYjqLJhjz2IHhMfnlvB%2BgYsfU2m2xR5%2FYclrp6SJtIXleCZtF94oxN9h2gb4fb42Jqag%2B%2F08%2FLI3OaLjKm9u2wCryLYbGwU%2FOpbE%2B%2B5U0X6LDmdDKkckW4OJmS8%2FBOZcgWWQ%2FKBlgvRq0hRG1YpdQdKGHaONu0LxfumRCwNkdzvRdmgm4NgsbWgO%2Fks0GG3ASmlrFF%2B9mufMb5M%2FMBZskvD42Hu8VtbbfE3SJq7BxHybx7lqQs%2B02c5onHUwYPu0vZYrOLroQ%2BfFFjHKMzEetPq%2F7ylPI9ofDamIXxxAarin3kufQeLmrJ4LwneIvBXr5RHd5wa2rbWAEsmLNBEhL2EJMKtT476hcbIAuUI3bC5F%2BkxOHp9i6ErImtRWbLssUUla4R5TGOWbLJWzkTH93xuRqAAapuIRuRt0d2Odr1hsaYukMd42UkNapdTrehzmXeR6lyv1jlLmkAHve9Cbl9N5bO3A96FSlEfjHksQBWG0CEXRm3jLW41bpR00dgnM6gpOj7lRW2z33L0dTtaRw79X3%2BUqz3gv9md5QvoaVi1jnr%2FcFRNxbjl7DI39pdcGlTI2lqIAA%3D\\",\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'voicebot:PreviewVoice',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'PublishScript' => [
'summary' => 'Publishes a specified version of a script.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '19ac2375-53e3-477f-abe9-6cd334227981', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'formData',
'schema' => ['description' => 'The script ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '64241e64-190c-45d1-af66-06f51c07b090', 'title' => ''],
],
[
'name' => 'VersionId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the script version to publish.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '64241e64-190c-45d1-af66-06f51c07b091', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response object.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request ', 'description' => 'The unique identifier for the request. Provide this ID when contacting support about this request.', 'type' => 'string', 'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD'],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'Code' => ['description' => 'The response code. A value of "OK" indicates that the call was successful.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Data' => ['description' => 'The ID of the published version.', 'type' => 'string', 'example' => '64241e64-190c-45d1-af66-06f51c07b091', 'title' => ''],
'Params' => [
'description' => 'A list of dynamic parameters that provide context for the "Message" field.',
'type' => 'array',
'items' => ['description' => 'A dynamic parameter for the message.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Publish scenario ',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": \\"64241e64-190c-45d1-af66-06f51c07b091\\",\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:PublishScript',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'UpdateCallCenterProvider' => [
'summary' => 'Modifies a human service provider in system administration.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'maxLength' => 64, 'example' => '36e9a4cd-a821-4f78-86fa-a9a4aefeea2e', 'title' => ''],
],
[
'name' => 'ProviderId',
'in' => 'formData',
'schema' => ['description' => 'The human service provider ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'xxxxxxxxx', 'title' => ''],
],
[
'name' => 'ProviderType',
'in' => 'formData',
'schema' => [
'description' => 'The provider type.'."\n"
.'> '."\n"
.'> - CCC: Cloud Call Center.'."\n"
.'>- CUSTOM: customer-owned contact center.',
'enumValueTitles' => ['CCC' => 'Cloud Call Center.', 'CUSTOM' => 'Customer-owned contact center.'],
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'CCC',
'title' => '',
],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => 'The name of the service provider.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '云联络中心内部服务提供商', 'title' => ''],
],
[
'name' => 'DisplayName',
'in' => 'query',
'schema' => ['description' => 'The display name of the service provider.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '云联络中心内部服务提供商', 'title' => ''],
],
[
'name' => 'ReferTo',
'in' => 'formData',
'schema' => ['description' => 'The Refer address.', 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''],
],
[
'name' => 'TrunkId',
'in' => 'formData',
'schema' => ['description' => 'The trunk ID.', 'type' => 'string', 'required' => false, 'example' => 'trunk-xxx', 'title' => ''],
],
[
'name' => 'Originator',
'in' => 'formData',
'schema' => ['description' => 'The caller number for the transfer. This parameter is required when the transfer method is set to Bridge.', 'type' => 'string', 'required' => false, 'example' => '010****', 'title' => ''],
],
[
'name' => 'Destination',
'in' => 'formData',
'schema' => ['description' => 'The callee number for the transfer. This parameter is required when the transfer method is set to Bridge.', 'type' => 'string', 'required' => false, 'example' => '153*********', 'title' => ''],
],
[
'name' => 'Extras',
'in' => 'formData',
'schema' => ['description' => 'The pass-through parameter.'."\n"
.'>Format: k1=v1;k2=v2>.', 'type' => 'string', 'required' => false, 'example' => 'key1=value1', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD'],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Data' => ['description' => 'The human service provider ID.', 'type' => 'string', 'example' => 'xxxxxxxxx', 'title' => ''],
'Params' => [
'description' => 'The dynamic error parameters.',
'type' => 'array',
'items' => ['description' => 'The dynamic error parameters.', 'type' => 'string', 'example' => '-', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Modify a human service provider',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:UpdateCallCenterProvider',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": \\"xxxxxxxxx\\",\\n \\"Params\\": [\\n \\"-\\"\\n ]\\n}","type":"json"}]',
],
'UpdateCloneVoice' => [
'summary' => 'Updates the properties of a specified clone voice.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '0099b75d-60fd-4c63-8541-7fbba0ae6bb0', 'title' => ''],
],
[
'name' => 'CloneVoiceId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the clone voice to update.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '8ee1160a-6999-478f-8df6-f33ef21f27d5', 'title' => ''],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => 'The new name for the clone voice.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '测试克隆音', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The data returned.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC'],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'Code' => ['description' => 'The status code of the operation.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Data' => ['description' => 'The ID of the updated clone voice.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66b', 'title' => ''],
'Params' => [
'description' => 'A list of parameters that provide context for the error.',
'type' => 'array',
'items' => ['description' => 'An error parameter.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Update clone voice ',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": \\"af81a389-91f0-4157-8d82-720edd02b66b\\",\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:UpdateCloneVoice',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'UpdateInstruction' => [
'summary' => 'Updates the global configuration of a specific instruction for a Digital Employee.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'maxLength' => 64, 'example' => '36e9a4cd-a821-4f78-86fa-a9a4aefeea2e', 'title' => ''],
],
[
'name' => 'Type',
'in' => 'formData',
'schema' => [
'description' => 'The type of the instruction.',
'enumValueTitles' => ['TRANSFER' => 'The instruction to transfer a call.', 'GATHER_DTMF' => 'The instruction to gather dual-tone multi-frequency (DTMF) signals.'],
'type' => 'string',
'required' => false,
'docRequired' => true,
'enum' => ['TRANSFER', 'GATHER_DTMF'],
'example' => 'TRANSFER',
'title' => '',
],
],
[
'name' => 'Code',
'in' => 'formData',
'schema' => ['description' => 'The unique code for the instruction.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'Transfer00', 'title' => ''],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => 'The name of the instruction.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '转人工指令一', 'title' => ''],
],
[
'name' => 'Config',
'in' => 'formData',
'schema' => ['description' => 'The configuration for the instruction, specified as a JSON string.'."\n"
."\n"
.'> - `providerId`: The ID of the live agent service provider. Call the `ListCallCenterProviders` operation to obtain this ID.'."\n"
.'>'."\n"
.'> - `transferMethod`: The method used for the transfer. Valid values: `BYE`, `BRIDGE`, and `REFER`.'."\n"
.'>'."\n"
.'> - `transferType`: The transfer destination type. Valid values: `External` (external number), `Agent` (agent), and `SkillGroup` (skill group).'."\n"
.'>'."\n"
.'> - `transferTarget`: The destination of the transfer, such as a phone number, an agent ID, or a skill group ID. The value of this parameter depends on the `transferType`.'."\n"
.'>'."\n"
.'> - `transferor`: The caller ID to display for the transfer. If this parameter is not specified, the caller\'s original phone number is used.'."\n"
.'>'."\n"
.'> - `timeoutSeconds`: The timeout in seconds for transferring a call to an agent. Default: 30.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '{'."\n"
.' "providerId": "xxxxxxxxx",'."\n"
.' "transferMethod": "BYE",'."\n"
.' "transferType": "External",'."\n"
.' "transferTarget": "152******",'."\n"
.' "transferor": "01*****",'."\n"
.' "timeoutSeconds": "10"'."\n"
.'}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response schema.',
'title' => '',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD'],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The response message. Returns "Success" if the request is successful, or an error message if it fails.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'Ok', 'title' => ''],
'Data' => ['description' => 'The code of the instruction.', 'type' => 'string', 'example' => 'Transfer00', 'title' => ''],
'Params' => [
'description' => 'The dynamic error parameters.',
'type' => 'array',
'items' => ['description' => 'A dynamic error parameter.', 'type' => 'string', 'example' => '36e9a4cd-a821-4f78-86fa-a9a4aefeea2e', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Modify Instruction ',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:UpdateInstruction',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Success\\",\\n \\"Code\\": \\"Ok\\",\\n \\"Data\\": \\"Transfer00\\",\\n \\"Params\\": [\\n \\"36e9a4cd-a821-4f78-86fa-a9a4aefeea2e\\"\\n ]\\n}","type":"json"}]',
],
'UpdateLlmAccessProfile' => [
'summary' => 'Updates a language model configuration.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'd74d6290-7cbe-4436-b5d7-014ebb0f4060', 'title' => ''],
],
[
'name' => 'AccessProfileId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the third-party model configuration.', 'type' => 'string', 'required' => false, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66b', 'title' => ''],
],
[
'name' => 'Profile',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => 'The profile details.',
'type' => 'object',
'properties' => [
'Name' => ['description' => 'The name of the third-party model configuration.', 'type' => 'string', 'required' => false, 'example' => '千问Omni', 'title' => ''],
'ApiKey' => ['description' => 'The API key for the third-party model.', 'type' => 'string', 'required' => false, 'example' => 'akm-091e4c2c-9938-4a0d-ade2-b9c477fbcbdb', 'title' => ''],
'Endpoint' => ['description' => 'The endpoint for the third-party model.', 'type' => 'string', 'required' => false, 'example' => 'api.llm.enpoint.example.com', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response object.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD'],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Data' => ['description' => 'The ID of the third-party model configuration.', 'type' => 'string', 'example' => 'e48e45dd-e47a-4744-a063-f08cbebb1c5b', 'title' => ''],
'Params' => [
'description' => 'A list of dynamic parameters for the error message.',
'type' => 'array',
'items' => ['description' => 'A dynamic parameter for the error message.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Update third-party model configuration ',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": \\"e48e45dd-e47a-4744-a063-f08cbebb1c5b\\",\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:UpdateLlmAccessProfile',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'UpdateScript' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '19ac2375-53e3-477f-abe9-6cd334227981', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'formData',
'schema' => ['description' => 'The script ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '64241e64-190c-45d1-af66-06f51c07b090', 'title' => ''],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => 'The script name.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '导航测试场景', 'title' => ''],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['description' => 'The script description.', 'type' => 'string', 'required' => false, 'example' => '用于测试', 'title' => ''],
],
[
'name' => 'Concurrency',
'in' => 'formData',
'schema' => ['description' => 'The maximum concurrent calls.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'F132DDBA-66C4-5BD3-BF7E-9642FE877158'],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Data' => ['description' => 'The script ID.', 'type' => 'string', 'example' => 'F132DDBA-66C4-5BD3-BF7E-9642FE877159', 'title' => ''],
'Params' => [
'type' => 'array',
'items' => ['description' => 'A dynamic error parameter.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'description' => 'The dynamic error parameters.',
'title' => '',
'example' => '',
],
],
'title' => '',
'description' => 'The response data.',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'UpdateScript',
'summary' => 'Updates a script.',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F132DDBA-66C4-5BD3-BF7E-9642FE877158\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": \\"F132DDBA-66C4-5BD3-BF7E-9642FE877159\\",\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:UpdateScript',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'UpdateSubscription' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
],
[
'name' => 'MqType',
'in' => 'formData',
'schema' => [
'description' => 'The message push type.',
'enumValueTitles' => ['ROCKET_MQ_4' => 'ROCKET\\_MQ\\_4', 'ROCKET_MQ_5' => 'ROCKET\\_MQ\\_5'],
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'ROCKET_MQ_4',
'title' => '',
],
],
[
'name' => 'EventSubscriptions',
'in' => 'formData',
'style' => 'json',
'schema' => [
'docRequired' => true,
'description' => 'The event subscription list.',
'type' => 'array',
'items' => ['description' => 'The subscription event.
'."\n"
.'Established: The call is connected.
'."\n"
.'Released: The call has ended.
'."\n"
.'RecordingReady: The recording is ready.
'."\n"
.'CdrReady: The call detail record (CDR) is generated.
'."\n"
.'LabelReady: The label is generated.
', 'type' => 'string', 'required' => false, 'example' => 'Released', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'Endpoint',
'in' => 'formData',
'schema' => ['description' => 'The endpoint. This parameter is required when MqType is set to ROCKET\\_MQ\\_4 or ROCKET\\_MQ\\_5.', 'type' => 'string', 'required' => false, 'maxLength' => 128, 'example' => 'rmq-cn-l4p89zajz67.cn-hangzhou.rmq.aliyuncs.com:8080', 'title' => ''],
],
[
'name' => 'Topic',
'in' => 'formData',
'schema' => ['description' => 'The topic of the queue. This parameter is required when MqType is set to ROCKET\\_MQ\\_4 or ROCKET\\_MQ\\_5.', 'type' => 'string', 'maxLength' => 64, 'required' => false, 'example' => 'test', 'title' => ''],
],
[
'name' => 'UserName',
'in' => 'formData',
'schema' => ['description' => 'The username. This parameter is required when MqType is set to ROCKET\\_MQ\\_5.', 'type' => 'string', 'maxLength' => 64, 'required' => false, 'example' => 'username', 'title' => ''],
],
[
'name' => 'Password',
'in' => 'formData',
'schema' => ['description' => 'The password. This parameter is required when MqType is set to ROCKET\\_MQ\\_5.', 'type' => 'string', 'maxLength' => 64, 'required' => false, 'example' => 'pwd', 'title' => ''],
],
[
'name' => 'MqInstanceId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the Message Queue (MQ) instance. This parameter is required when MqType is set to ROCKET\\_MQ\\_5.', 'type' => 'string', 'maxLength' => 64, 'required' => false, 'example' => 'rmq-cn-l4p89zajz67.cn', 'title' => ''],
],
[
'name' => 'ProducerId',
'in' => 'formData',
'schema' => ['description' => 'The producer ID. This parameter is required when MqType is set to ROCKET\\_MQ\\_4.', 'type' => 'string', 'maxLength' => 64, 'required' => false, 'example' => 'user1', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD'],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Data' => ['description' => 'This parameter is not used.', 'type' => 'string', 'example' => '暂无使用', 'title' => ''],
'Params' => [
'description' => 'The list of dynamic error parameters.',
'type' => 'array',
'items' => ['description' => 'The dynamic error parameter.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Update subscription information ',
'summary' => 'Create or update MQ configuration',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": \\"暂无使用\\",\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:UpdateSubscription',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'UpdateVariable' => [
'summary' => 'Updates a variable.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '026ca0f4-483b-4252-ae1d-1f15f056f8b9', 'title' => ''],
],
[
'name' => 'VariableId',
'in' => 'formData',
'schema' => ['description' => 'The variable ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66b', 'title' => ''],
],
[
'name' => 'DisplayName',
'in' => 'formData',
'schema' => ['description' => 'The display name.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '年龄', 'title' => ''],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['description' => 'The description.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '用户当前年龄', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response object.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC'],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Data' => ['description' => 'The variable ID.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66b', 'title' => ''],
'Params' => [
'description' => 'Dynamic parameters for the error.',
'type' => 'array',
'items' => ['description' => 'A dynamic parameter for the error.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Update variable ',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": \\"af81a389-91f0-4157-8d82-720edd02b66b\\",\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:UpdateVariable',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'UpdateVocabulary' => [
'summary' => 'Updates a vocabulary.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
],
[
'name' => 'VocabularyId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the vocabulary to update.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'd74d6290-7cbe-4436-b5d7-014ebb0f4061', 'title' => ''],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => 'The new vocabulary name.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '金融场景热词', 'title' => ''],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['description' => 'The new description of the vocabulary.', 'type' => 'string', 'required' => false, 'example' => '包含金融场景专业术语', 'title' => ''],
],
[
'name' => 'Words',
'in' => 'formData',
'style' => 'json',
'schema' => [
'docRequired' => true,
'description' => 'A JSON object that maps words to their corresponding weights. If provided, this object replaces the entire existing word list.',
'additionalProperties' => ['description' => 'The key is a word and the value is its weight.', 'type' => 'string', 'example' => '{"苹果":"2","香蕉":"3"}', 'title' => ''],
'type' => 'object',
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response object.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7401D698-0AAC-5909-B68E-88C68805FFB8'],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Data' => ['description' => 'The ID of the updated vocabulary.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66b', 'title' => ''],
'Params' => [
'description' => 'A list of dynamic error parameters.',
'type' => 'array',
'items' => ['description' => 'A dynamic error parameter.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Update hotword ',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7401D698-0AAC-5909-B68E-88C68805FFB8\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": \\"af81a389-91f0-4157-8d82-720edd02b66b\\",\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:UpdateVocabulary',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'UpdateVoiceAccessProfile' => [
'summary' => 'Updates a voice access profile.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
],
[
'name' => 'AccessProfileId',
'in' => 'formData',
'schema' => ['description' => 'The access profile ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66b', 'title' => ''],
],
[
'name' => 'NlsEngine',
'in' => 'formData',
'schema' => [
'description' => 'The voice engine.',
'enumValueTitles' => ['IFLYTEK' => ': The iFLYTEK engine.', 'VOLC' => ': The Doubao engine from VOLCENGINE.', 'BAILIAN' => ': The Model Studio engine.'],
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'VOLC',
'title' => '',
],
],
[
'name' => 'Profile',
'in' => 'formData',
'style' => 'json',
'schema' => [
'docRequired' => true,
'description' => 'The parameter configuration for the selected voice engine.',
'type' => 'object',
'properties' => [
'AppKey' => ['description' => 'This parameter is required when `NlsEngine` is set to `VOLC`.', 'type' => 'string', 'maxLength' => 64, 'required' => false, 'example' => '2541370123', 'title' => ''],
'AccessKey' => ['description' => 'This parameter is required when `NlsEngine` is set to `VOLC`.', 'type' => 'string', 'maxLength' => 64, 'required' => false, 'example' => 'HwRnTXgwnQOlsj68URDS5_VMm4Wtapq9', 'title' => ''],
'AppId' => ['description' => 'This parameter is required when `NlsEngine` is set to `IFLYTEK`.', 'type' => 'string', 'maxLength' => 64, 'required' => false, 'example' => '5b123bfb', 'title' => ''],
'ApiKey' => ['description' => 'This parameter is required when `NlsEngine` is set to `BAILIAN` or `IFLYTEK`.', 'type' => 'string', 'maxLength' => 64, 'required' => false, 'example' => 'sk-12341e259b1049e8872b47981e545f78', 'title' => ''],
'ApiSecret' => ['description' => 'This parameter is required when `NlsEngine` is set to `IFLYTEK`.', 'type' => 'string', 'maxLength' => 64, 'required' => false, 'example' => 'c0358c6e51c1013b446fdeb21a3a1234', 'title' => ''],
'AsrAppKey' => ['description' => 'Reserved for future use.', 'type' => 'string', 'maxLength' => 64, 'required' => false, 'example' => '暂无使用', 'title' => ''],
'TtsApiKey' => ['description' => 'Reserved for future use.', 'type' => 'string', 'maxLength' => 64, 'required' => false, 'example' => '暂无使用', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response object.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7401D698-0AAC-5909-B68E-88C68805FFB8'],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The error message if the request fails.', 'type' => 'string', 'example' => 'Instance af81a389-91f0-4157-8d82-720edd02b66a'."\n"
.' does not exist.', 'title' => ''],
'Code' => ['description' => 'The status code of the operation. `OK` indicates that the request was successful.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Data' => ['description' => 'The ID of the updated access profile.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66b', 'title' => ''],
'Params' => [
'description' => 'The dynamic error parameter list.',
'type' => 'array',
'items' => ['description' => 'A dynamic parameter that provides additional context for an error.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Update third-party voice configuration ',
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7401D698-0AAC-5909-B68E-88C68805FFB8\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance af81a389-91f0-4157-8d82-720edd02b66a\\\\n does not exist.\\",\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": \\"af81a389-91f0-4157-8d82-720edd02b66b\\",\\n \\"Params\\": [\\n \\"af81a389-91f0-4157-8d82-720edd02b66a\\"\\n ]\\n}","type":"json"}]',
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:UpdateVoiceAccessProfile',
'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' => [],
'ram' => [
'productCode' => 'VoiceNavigator',
'productName' => 'VoiceNavigator',
'ramCodes' => ['voicebot'],
'ramLevel' => 'OPERATION',
'ramConditions' => [],
'ramActions' => [
[
'apiName' => 'GetScript',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:GetScript',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'PreviewVoice',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'voicebot:PreviewVoice',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListVocabulary',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:ListVocabulary',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteLlmAccessProfile',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'voicebot:DeleteLlmAccessProfile',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListScripts',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:ListScripts',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteVoiceAccessProfile',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'voicebot:DeleteVoiceAccessProfile',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetInstanceTrendingReport',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:GetInstanceTrendingReport',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetRealtimeScriptStats',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:GetRealtimeScriptStats',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListVoiceEngines',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:ListVoiceEngines',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateSubscription',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:UpdateSubscription',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateCloneVoice',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:UpdateCloneVoice',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListBackgroundMusics',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:ListBackgroundMusics',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListHistoricalScriptReport',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:ListHistoricalScriptReport',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateVariable',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:UpdateVariable',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetScriptTrendingReport',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:GetScriptTrendingReport',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListNluModels',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:ListNluModels',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListCloneVoiceModels',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:ListCloneVoiceModels',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListVariable',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:ListVariable',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListVoiceAccessProfile',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:ListVoiceAccessProfile',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetRealtimeInstanceStats',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:GetRealtimeInstanceStats',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateCallCenterProvider',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:UpdateCallCenterProvider',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListCloneVoice',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:ListCloneVoice',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListVoices',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:ListVoices',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateCallCenterProvider',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:CreateCallCenterProvider',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListLlmAccessProfiles',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:ListLlmAccessProfiles',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateScript',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'voicebot:CreateScript',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'BeginSession',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'voicebot:BeginSession',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetCallDetailRecord',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:GetCallDetailRecord',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateLlmAccessProfile',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:UpdateLlmAccessProfile',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetRecording',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:GetRecording',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetSubscription',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:GetSubscription',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListCallDetailRecords',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:ListCallDetailRecords',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ExportScript',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:ExportScript',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateVocabulary',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:UpdateVocabulary',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'PublishScript',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:PublishScript',
'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' => 'DeleteCloneVoice',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'voicebot:DeleteCloneVoice',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ImportVocabulary',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'voicebot:ImportVocabulary',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateScriptVersion',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'voicebot:CreateScriptVersion',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateInstruction',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:UpdateInstruction',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateCloneVoice',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'voicebot:CreateCloneVoice',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateLlmAccessProfile',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'voicebot:CreateLlmAccessProfile',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetDataChannelCredential',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:GetDataChannelCredential',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListInstructions',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:ListInstructions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DisableSubscription',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:DisableSubscription',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteScript',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'voicebot:DeleteScript',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'EndSession',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:EndSession',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateVocabulary',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'voicebot:CreateVocabulary',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateScript',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:UpdateScript',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'BridgeWebCall',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'voicebot:BridgeWebCall',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteVariable',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'voicebot:DeleteVariable',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateInstruction',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:CreateInstruction',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListRealtimeInstanceStats',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:ListRealtimeInstanceStats',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ExportVocabulary',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:ExportVocabulary',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteCallCenterProvider',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:DeleteCallCenterProvider',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateVariable',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'voicebot:CreateVariable',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetVocabulary',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:GetVocabulary',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListScriptProfileTemplates',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:ListScriptProfileTemplates',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GenerateFileUploadParams',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:GenerateFileUploadParams',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateVoiceAccessProfile',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:UpdateVoiceAccessProfile',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteVocabulary',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'voicebot:DeleteVocabulary',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListCallCenterProviders',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:ListCallCenterProviders',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListHistoricalInstanceReport',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:ListHistoricalInstanceReport',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateVoiceAccessProfile',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'voicebot:CreateVoiceAccessProfile',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteInstruction',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:DeleteInstruction',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'resourceTypes' => [],
],
];