'1.0',
'info' => [
'style' => 'RPC',
'product' => 'VoiceNavigator',
'version' => '2018-06-12',
],
'directories' => [
[
'id' => 77502,
'title' => null,
'type' => 'directory',
'children' => [
'ModifyGreetingConfig',
'ModifySilenceTimeoutConfig',
'ModifyTTSConfig',
'ModifyUnrecognizingConfig',
'DescribeTTSConfig',
'DescribeExportProgress',
'AssociateChatbotInstance',
'AuditTTSVoice',
'CollectedNumber',
'ExportStatisticalData',
'SilenceTimeout',
],
],
[
'id' => 77514,
'title' => null,
'type' => 'directory',
'children' => [
'DescribeConversation',
'DescribeConversationContext',
'ListConversationDetails',
'QueryConversations',
'DescribeRecording',
'Dialogue',
'EndDialogue',
'SaveRecording',
],
],
[
'id' => 77523,
'title' => null,
'type' => 'directory',
'children' => [
'ListConversations',
'BeginDialogue',
'ExportConversationDetails',
],
],
[
'id' => 77527,
'title' => null,
'type' => 'directory',
'children' => [
'DebugBeginDialogue',
'DebugCollectedNumber',
'DebugDialogue',
],
],
[
'id' => 77531,
'title' => null,
'type' => 'directory',
'children' => [
'CreateInstance',
'DeleteInstance',
'DisableInstance',
'EnableInstance',
'ModifyInstance',
'DescribeNavigationConfig',
'DescribeInstance',
'DescribeStatisticalData',
'ListInstances',
],
],
[
'id' => 223825,
'title' => null,
'type' => 'directory',
'children' => [
'ListChatbotInstances',
'CreateDownloadUrl',
'ListDownloadTasks',
'ModifyAsrConfig',
'GetAsrConfig',
'GetRealTimeConcurrency',
],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'ModifyGreetingConfig' => [
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '12f407b22cbe4890ac595f09985848d5',
],
],
[
'name' => 'GreetingWords',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '',
],
],
[
'name' => 'SourceType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'chatbotIntent',
],
],
[
'name' => 'IntentTrigger',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'InvalidInstanceId.NotFound',
'errorMessage' => 'The specified InstanceId does not exist.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\"\\n}","errorExample":""},{"type":"xml","example":"14C39896-AE6D-4643-9C9A-E0566B2C2DDD","errorExample":""}]',
'title' => 'ModifyGreetingConfig',
],
'ModifySilenceTimeoutConfig' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '12f407b22cbe4890ac595f09985848d5',
],
],
[
'name' => 'Prompt',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '',
],
],
[
'name' => 'Timeout',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '20',
],
],
[
'name' => 'Threshold',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '3',
],
],
[
'name' => 'FinalPrompt',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '',
],
],
[
'name' => 'FinalAction',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'TransferToAgent',
],
],
[
'name' => 'FinalActionParams',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '{}',
],
],
[
'name' => 'SourceType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'chatbotIntent',
],
],
[
'name' => 'IntentTrigger',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Timeout',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'InvalidInstanceId.NotFound',
'errorMessage' => 'The specified InstanceId does not exist.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\"\\n}","errorExample":""},{"type":"xml","example":"14C39896-AE6D-4643-9C9A-E0566B2C2DDD","errorExample":""}]',
'title' => 'ModifySilenceTimeoutConfig',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ModifyTTSConfig' => [
'summary' => '修改TTS配置',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '12f407b22cbe4890ac595f09985848d5',
],
],
[
'name' => 'Voice',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'aixia',
],
],
[
'name' => 'SpeechRate',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '100',
],
],
[
'name' => 'Volume',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '10',
],
],
[
'name' => 'PitchRate',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'NlsServiceType',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'AppKey',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'Engine',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'EngineXunfei',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'AliCustomizedVoice',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'TtsOverrides',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'InvalidInstanceId.NotFound',
'errorMessage' => 'The specified InstanceId does not exist.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => 'ModifyTTSConfig',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ModifyUnrecognizingConfig' => [
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '12f407b22cbe4890ac595f09985848d5',
],
],
[
'name' => 'Prompt',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '',
],
],
[
'name' => 'Threshold',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '3',
],
],
[
'name' => 'FinalPrompt',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '',
],
],
[
'name' => 'FinalAction',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'TransferToAgent',
],
],
[
'name' => 'FinalActionParams',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '{}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'InvalidInstanceId.NotFound',
'errorMessage' => 'The specified InstanceId does not exist.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\"\\n}","errorExample":""},{"type":"xml","example":"14C39896-AE6D-4643-9C9A-E0566B2C2DDD","errorExample":""}]',
'title' => 'ModifyUnrecognizingConfig',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeTTSConfig' => [
'summary' => '获取TTS配置',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'dc437bba-5a25-4bbc-b4c2-f268864bebb5',
],
],
[
'name' => 'InstanceOwnerId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1971226538081821',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'F132DDBA-66C4-5BD3-BF7E-9642FE877158',
],
'Volume' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '50',
],
'Voice' => [
'description' => '',
'type' => 'string',
'example' => 'aixia',
],
'SpeechRate' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '-150',
],
'NlsServiceType' => [
'type' => 'string',
],
'AppKey' => [
'type' => 'string',
],
'Engine' => [
'type' => 'string',
],
'EngineXunfei' => [
'type' => 'string',
],
'PitchRate' => [
'type' => 'integer',
'format' => 'int32',
],
'AliCustomizedVoice' => [
'type' => 'string',
],
'TtsOverrides' => [
'type' => 'string',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'InvalidInstanceId.NotFound',
'errorMessage' => 'The specified InstanceId does not exist.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F132DDBA-66C4-5BD3-BF7E-9642FE877158\\",\\n \\"Volume\\": 50,\\n \\"Voice\\": \\"aixia\\",\\n \\"SpeechRate\\": -150,\\n \\"NlsServiceType\\": \\"\\",\\n \\"AppKey\\": \\"\\",\\n \\"Engine\\": \\"\\",\\n \\"EngineXunfei\\": \\"\\",\\n \\"PitchRate\\": 0,\\n \\"AliCustomizedVoice\\": \\"\\",\\n \\"TtsOverrides\\": \\"\\"\\n}","type":"json"}]',
],
'DescribeExportProgress' => [
'summary' => 'DescribeExportProgress',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '868eef14-7515-4856-8a50-5c9a22abdbcc',
],
],
[
'name' => 'ExportTaskId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0de8e5ccc2b645039ae6fbda443da73f',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'FINISHED',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'b19af5ce5314ac08108d1b33fe20e15',
],
'FileHttpUrl' => [
'description' => '',
'type' => 'string',
'example' => 'http://ssml-test.oss-cn-shanghai.aliyuncs.com/key',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'InvalidInstanceId.NotFound',
'errorMessage' => 'The specified InstanceId does not exist.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"FINISHED\\",\\n \\"FileHttpUrl\\": \\"http://ssml-test.oss-cn-shanghai.aliyuncs.com/key\\",\\n \\"RequestId\\": \\"b19af5ce5314ac08108d1b33fe20e15\\"\\n}","errorExample":""},{"type":"xml","example":"http://ssml-test.oss-cn-shanghai.aliyuncs.com/key\\nb19af5ce5314ac08108d1b33fe20e15\\nFINISHED","errorExample":""}]',
'title' => 'DescribeExportProgress',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AssociateChatbotInstance' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'af81a389-91f0-4157-8d82-720edd02b66a',
],
],
[
'name' => 'ChatbotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'chatbot-720edd02b66a',
],
],
[
'name' => 'ChatbotName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
[
'name' => 'UnionSource',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'NluServiceParamsJson',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'NluServiceType',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\"\\n}","errorExample":""},{"type":"xml","example":"254EB995-DEDF-48A4-9101-9CA5B72FFBCC","errorExample":""}]',
'title' => 'AssociateChatbotInstance',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AuditTTSVoice' => [
'summary' => 'AuditTTSVoice',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'af81a389-91f0-4157-8d82-720edd02b66a',
],
],
[
'name' => 'Voice',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'aixia',
],
],
[
'name' => 'Text',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '',
],
],
[
'name' => 'SpeechRate',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => false,
'example' => '100',
],
],
[
'name' => 'Volume',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '10',
],
],
[
'name' => 'Engine',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'PitchRate',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'SecretKey',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'AccessKey',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'AppKey',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'AuditionUrl' => [
'description' => '',
'type' => 'string',
'example' => 'http://voicenavigator-cn-shanghai.oss-cn-shanghai.aliyuncs.com/exported_files/2020-02-20/ttsConfig-1582188148528-abd8e407de0a49b381bb591bd91fc073.wav?Expires=1582188208&OSSAccessKeyId=LTAIppQY5rofntVJ&Signature=FaBassElzqGEB0H2TvTKPJsOJHs%3D',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'InvalidInstanceId.NotFound',
'errorMessage' => 'The specified InstanceId does not exist.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"AuditionUrl\\": \\"http://voicenavigator-cn-shanghai.oss-cn-shanghai.aliyuncs.com/exported_files/2020-02-20/ttsConfig-1582188148528-abd8e407de0a49b381bb591bd91fc073.wav?Expires=1582188208&OSSAccessKeyId=LTAIppQY5rofntVJ&Signature=FaBassElzqGEB0H2TvTKPJsOJHs%3D\\"\\n}","errorExample":""},{"type":"xml","example":"5100B51E-2C4E-4F3C-8784-92827F501D73\\nhttp://voicenavigator-cn-shanghai.oss-cn-shanghai.aliyuncs.com/exported_files/2020-02-20/ttsConfig-1582188148528-abd8e407de0a49b381bb591bd91fc073.wav?Expires=1582188208&OSSAccessKeyId=LTAIppQY5rofntVJ&Signature=FaBassElzqGEB0H2TvTKPJsOJHs%3D","errorExample":""}]',
'title' => 'AuditTTSVoice',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CollectedNumber' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0099b75d-60fd-4c63-8541-7fbba0ae6bb0',
],
],
[
'name' => 'ConversationId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0099b75d-60fd-4c63-8541-7fbba0ae6bb0',
],
],
[
'name' => 'Number',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1500060224',
],
],
[
'name' => 'InstanceOwnerId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1426738157626835',
],
],
[
'name' => 'AdditionalContext',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Action' => [
'description' => '',
'type' => 'string',
'example' => 'Broadcast',
],
'Interruptible' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'da37319b-6c83-4268-9f19-814aed62e401',
],
'ActionParams' => [
'description' => '',
'type' => 'string',
'example' => '{\\"duration\\":31340,\\"endTime\\":1638243934786,\\"hangUpDirection\\":\\"ivr\\",\\"startTime\\":1638243903446}',
],
'TextResponse' => [
'description' => '',
'type' => 'string',
'example' => '',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'InvalidInstanceId.NotFound',
'errorMessage' => 'The specified InstanceId does not exist.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Action\\": \\"Broadcast\\",\\n \\"Interruptible\\": false,\\n \\"RequestId\\": \\"da37319b-6c83-4268-9f19-814aed62e401\\",\\n \\"ActionParams\\": \\"{\\\\\\\\\\\\\\"duration\\\\\\\\\\\\\\":31340,\\\\\\\\\\\\\\"endTime\\\\\\\\\\\\\\":1638243934786,\\\\\\\\\\\\\\"hangUpDirection\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ivr\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"startTime\\\\\\\\\\\\\\":1638243903446}\\",\\n \\"TextResponse\\": \\"收号内容是123\\"\\n}","type":"json"}]',
],
'ExportStatisticalData' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '29b52d70-d9fe-4fe0-8476-8aaacbcfdc84',
],
],
[
'name' => 'TimeUnit',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'Hour',
],
],
[
'name' => 'ExportType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'statistical',
],
],
[
'name' => 'BeginTimeLeftRange',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1582266750353',
],
],
[
'name' => 'BeginTimeRightRange',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1582266750353',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'c62e6789-28a8-41db-941e-171a01d3b3b9',
],
'ExportTaskId' => [
'description' => '',
'type' => 'string',
'example' => '6be5a9f1-406e-424e-a17b-b6fb86ee3cc9',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidParameter',
'errorMessage' => 'The specified parameter %s is invalid.',
],
],
404 => [
[
'errorCode' => 'InvalidInstanceId.NotFound',
'errorMessage' => 'The specified InstanceId does not exist.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"ExportTaskId\\": \\"6be5a9f1-406e-424e-a17b-b6fb86ee3cc9\\",\\n \\"RequestId\\": \\"c62e6789-28a8-41db-941e-171a01d3b3b9\\"\\n}","errorExample":""},{"type":"xml","example":"c62e6789-28a8-41db-941e-171a01d3b3b9\\n6be5a9f1-406e-424e-a17b-b6fb86ee3cc9","errorExample":""}]',
'title' => 'ExportStatisticalData',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SilenceTimeout' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0099b75d-60fd-4c63-8541-7fbba0ae6bb0',
],
],
[
'name' => 'ConversationId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0099b75d-60fd-4c63-8541-7fbba0ae6bb0',
],
],
[
'name' => 'InitialContext',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '{}',
],
],
[
'name' => 'InstanceOwnerId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1231639035307976',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Action' => [
'description' => '',
'type' => 'string',
'example' => 'TransferToAgent',
],
'Interruptible' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'ActionParams' => [
'description' => '',
'type' => 'string',
'example' => '{ "skillGroupId": "ABC"}',
],
'TextResponse' => [
'description' => '',
'type' => 'string',
'example' => '',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'InvalidConversationId.NotFound',
'errorMessage' => 'The specified ConversationId does not exist in our record.',
],
[
'errorCode' => 'InvalidInstanceId.NotFound',
'errorMessage' => 'The specified InstanceId does not exist.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Action\\": \\"TransferToAgent\\",\\n \\"Interruptible\\": false,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"ActionParams\\": \\"{ \\\\\\"skillGroupId\\\\\\": \\\\\\"ABC\\\\\\"}\\",\\n \\"TextResponse\\": \\"正在为你转接人工坐席\\"\\n}","errorExample":""},{"type":"xml","example":"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\n正在为你转接人工坐席\\n{ \\"skillGroupId\\": \\"ABC\\"}\\nfalse\\nTransferToAgent","errorExample":""}]',
'title' => 'SilenceTimeout',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeConversation' => [
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '5daac920-d6c1-429f-a95f-2a798f5255b5',
],
],
[
'name' => 'ConversationId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '15608cce-36be-43d5-9361-178cbe64127b',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'EffectiveAnswerCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '8',
],
'ConversationId' => [
'description' => '',
'type' => 'string',
'example' => '2d5aa451-661f-4f08-b0c4-28eec78decc4',
],
'TransferredToAgent' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'EndTime' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1582103299434',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD',
],
'BeginTime' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1582103260434',
],
'SkillGroupId' => [
'description' => '',
'type' => 'string',
'example' => 'ABABCBAC',
],
'CallingNumber' => [
'description' => '',
'type' => 'string',
'example' => '138106*****',
],
'UserUtteranceCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": 1582103299434,\\n \\"EffectiveAnswerCount\\": 8,\\n \\"TransferredToAgent\\": true,\\n \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\",\\n \\"SkillGroupId\\": \\"ABABCBAC\\",\\n \\"BeginTime\\": 1582103260434,\\n \\"ConversationId\\": \\"2d5aa451-661f-4f08-b0c4-28eec78decc4\\",\\n \\"CallingNumber\\": \\"138106*****\\",\\n \\"UserUtteranceCount\\": 10\\n}","errorExample":""},{"type":"xml","example":"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\n13810671937\\n2018-05-02T00:00:00Z\\n2018-05-02T00:00:30Z\\ntrue\\nAAA\\n10\\n8","errorExample":""}]',
'title' => 'DescribeConversation',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeConversationContext' => [
'summary' => 'DescribeConversationContext',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '026ca0f4-483b-4252-ae1d-1f15f056f8b9',
],
],
[
'name' => 'ConversationId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '361c8a53-0e29-42f3-8aa7-c7752d010399',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'b19af5ce5314ac08108d1b33fe20e15',
],
'ConversationContext' => [
'description' => '',
'type' => 'string',
'example' => ' { "CallingNumber": "135815***", "AdditionalContext": "", "ConversationId": "361c8a53-0e29-42f3-8aa7-c7752d010399" }',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'InvalidConversationId.NotFound',
'errorMessage' => 'The specified ConversationId does not exist in our record.',
],
[
'errorCode' => 'InvalidInstanceId.NotFound',
'errorMessage' => 'The specified InstanceId does not exist.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"ConversationContext\\": \\" { \\\\\\"CallingNumber\\\\\\": \\\\\\"135815***\\\\\\", \\\\\\"AdditionalContext\\\\\\": \\\\\\"\\\\\\", \\\\\\"ConversationId\\\\\\": \\\\\\"361c8a53-0e29-42f3-8aa7-c7752d010399\\\\\\" }\\",\\n \\"RequestId\\": \\"b19af5ce5314ac08108d1b33fe20e15\\"\\n}","errorExample":""},{"type":"xml","example":"b19af5ce5314ac08108d1b33fe20e15\\n\\n 135815***\\n \\n 361c8a53-0e29-42f3-8aa7-c7752d010399\\n","errorExample":""}]',
'title' => 'DescribeConversationContext',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListConversationDetails' => [
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '82b2eaae-ce5c-45f8-8231-f15b6b27e55c',
],
],
[
'name' => 'ConversationId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'a2c26e67-5984-4935-984e-bcee52971993',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD',
],
'ConversationDetails' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Action' => [
'description' => '',
'type' => 'string',
'example' => 'Dialogue',
],
'Speaker' => [
'description' => '',
'type' => 'string',
'example' => 'Chatbot',
],
'CreateTime' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1582266750353',
],
'ConversationId' => [
'description' => '',
'type' => 'string',
'example' => 'af81a389-91f0-4157-8d82-720edd02b66a',
],
'ActionParams' => [
'description' => '',
'type' => 'string',
'example' => '{}',
],
'SequenceId' => [
'description' => '',
'type' => 'string',
'example' => 'af81a389-91f0-4157-8d82-720edd02b66a',
],
'Utterance' => [
'description' => '',
'type' => 'string',
'example' => '',
],
],
],
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'InvalidConversationId.NotFound',
'errorMessage' => 'The specified ConversationId does not exist in our record.',
],
[
'errorCode' => 'InvalidInstanceId.NotFound',
'errorMessage' => 'The specified InstanceId does not exist.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\",\\n \\"ConversationDetails\\": [\\n {\\n \\"Action\\": \\"Dialogue\\",\\n \\"Speaker\\": \\"Chatbot\\",\\n \\"CreateTime\\": 1582266750353,\\n \\"ConversationId\\": \\"af81a389-91f0-4157-8d82-720edd02b66a\\",\\n \\"ActionParams\\": \\"{}\\",\\n \\"SequenceId\\": \\"af81a389-91f0-4157-8d82-720edd02b66a\\",\\n \\"Utterance\\": \\"你好\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\n\\n abcde\\n Customer\\n 你好\\n Dialogue\\n {}\\n 2018-07-02 20:37:40\\n 2\\n","errorExample":""}]',
'title' => 'ListConversationDetails',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryConversations' => [
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '12f407b22cbe4890ac595f09985848d5',
],
],
[
'name' => 'CallingNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '02811111111',
],
],
[
'name' => 'BeginTimeLeftRange',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1582183381000',
],
],
[
'name' => 'BeginTimeRightRange',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1582356181000',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
'maximum' => '100',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '10',
'maximum' => '200',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'PageSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD',
],
'PageNumber' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Conversations' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EndTime' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1582183481000',
],
'EffectiveAnswerCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '8',
],
'TransferredToAgent' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'BeginTime' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1582183381000',
],
'SkillGroupId' => [
'description' => '',
'type' => 'string',
'example' => 'AAA',
],
'ConversationId' => [
'description' => '',
'type' => 'string',
'example' => 'af81a389-91f0-4157-8d82-720edd02b66a',
],
'CallingNumber' => [
'description' => '',
'type' => 'string',
'example' => '02811111111',
],
'UserUtteranceCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidParameter',
'errorMessage' => 'The specified parameter %s is invalid.',
],
],
404 => [
[
'errorCode' => 'InvalidInstanceId.NotFound',
'errorMessage' => 'The specified InstanceId does not exist.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 100,\\n \\"Conversations\\": [\\n {\\n \\"EndTime\\": 1582183481000,\\n \\"EffectiveAnswerCount\\": 8,\\n \\"TransferredToAgent\\": true,\\n \\"BeginTime\\": 1582183381000,\\n \\"SkillGroupId\\": \\"AAA\\",\\n \\"ConversationId\\": \\"af81a389-91f0-4157-8d82-720edd02b66a\\",\\n \\"CallingNumber\\": \\"02811111111\\",\\n \\"UserUtteranceCount\\": 10\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\n1\\n10\\n100\\n\\n 02811111111\\n 1582183381000\\n 1582183481000\\n true\\n AAA\\n 10\\n 8\\n af81a389-91f0-4157-8d82-720edd02b66a\\n","errorExample":""}]',
'title' => 'QueryConversations',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeRecording' => [
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '7cefbff0-8d50-4d6f-b93c-73cee23c1555',
],
],
[
'name' => 'ConversationId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'abb4aa26-3a8e-43dd-82f8-0c3898c9c67f',
],
],
[
'name' => 'NeedVoiceSliceRecording',
'in' => 'query',
'schema' => [
'type' => 'boolean',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'FilePath' => [
'description' => '',
'type' => 'string',
'example' => 'url',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD',
],
'FileName' => [
'description' => '',
'type' => 'string',
'example' => '2019080913202222.wav',
],
'VoiceSliceRecordingListJson' => [
'type' => 'string',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'InvalidConversationId.NotFound',
'errorMessage' => 'The specified ConversationId does not exist in our record.',
],
[
'errorCode' => 'InvalidInstanceId.NotFound',
'errorMessage' => 'The specified InstanceId does not exist.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"FilePath\\": \\"url\\",\\n \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\",\\n \\"FileName\\": \\"2019080913202222.wav\\"\\n}","errorExample":""},{"type":"xml","example":"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\nurl\\n2019080913202222.wav","errorExample":""}]',
'title' => 'DescribeRecording',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'Dialogue' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '21e0b2a3-168d-4ba7-9009-afc42666eb54',
],
],
[
'name' => 'ConversationId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'da37319b-6c83-4268-9f19-814aed62e401',
],
],
[
'name' => 'Utterance',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '',
],
],
[
'name' => 'CalledNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '10086',
],
],
[
'name' => 'CallingNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '18851708605',
],
],
[
'name' => 'AdditionalContext',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '{}',
],
],
[
'name' => 'InstanceOwnerId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1426738157626835',
],
],
[
'name' => 'Emotion',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Action' => [
'description' => '',
'type' => 'string',
'example' => 'Broadcast',
],
'Interruptible' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '9DB8BA95-4513-54B9-9C67-A28909CFB4AD',
],
'ActionParams' => [
'description' => '',
'type' => 'string',
'example' => '{\\"duration\\":2420,\\"endTime\\":1651717326805,\\"hangUpDirection\\":\\"client\\",\\"hasLastPlaybackCompleted\\":true,\\"startTime\\":1651717324385}',
],
'TextResponse' => [
'description' => '',
'type' => 'string',
'example' => '',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'InvalidInstanceId.NotFound',
'errorMessage' => 'The specified InstanceId does not exist.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Action\\": \\"Broadcast\\",\\n \\"Interruptible\\": true,\\n \\"RequestId\\": \\"9DB8BA95-4513-54B9-9C67-A28909CFB4AD\\",\\n \\"ActionParams\\": \\"{\\\\\\\\\\\\\\"duration\\\\\\\\\\\\\\":2420,\\\\\\\\\\\\\\"endTime\\\\\\\\\\\\\\":1651717326805,\\\\\\\\\\\\\\"hangUpDirection\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"client\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"hasLastPlaybackCompleted\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"startTime\\\\\\\\\\\\\\":1651717324385}\\",\\n \\"TextResponse\\": \\"您好,欢迎致电智能助手\\"\\n}","type":"json"}]',
],
'EndDialogue' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'e48e45dd-e47a-4744-a063-f08cbebb1c5a',
],
],
[
'name' => 'ConversationId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '8fb819b5-d032-48a9-ae5e-cff041b83596',
],
],
[
'name' => 'InstanceOwnerId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1399572315967217',
],
],
[
'name' => 'HangUpParams',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '{\\"duration\\":40,\\"endTime\\":1645082505345,\\"hangUpDirection\\":\\"ivr\\",\\"hasLastPlaybackCompleted\\":true,\\"startTime\\":1645082505305}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'e48e45dd-e47a-4744-a063-f08cbebb1c5a',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'InvalidInstanceId.NotFound',
'errorMessage' => 'The specified InstanceId does not exist.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"e48e45dd-e47a-4744-a063-f08cbebb1c5a\\"\\n}","errorExample":""},{"type":"xml","example":"e48e45dd-e47a-4744-a063-f08cbebb1c5a","errorExample":""}]',
'title' => 'EndDialogue',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveRecording' => [
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'af81a389-91f0-4157-8d82-720edd02b66a',
],
],
[
'name' => 'ConversationId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '390515b5-6115-4ccf-83e2-52d5bfaf2ddf',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '1582267398628',
],
],
[
'name' => 'Duration',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '10',
],
],
[
'name' => 'FileName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'e6bef0db439d4048bfcf45322491becf.wav',
],
],
[
'name' => 'FilePath',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'oss://test/record/',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'Source',
],
],
[
'name' => 'InstanceOwnerId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1971226538081821',
],
],
[
'name' => 'VoiceSliceRecordingList',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'InvalidConversationId.NotFound',
'errorMessage' => 'The specified ConversationId does not exist in our record.',
],
[
'errorCode' => 'InvalidInstanceId.NotFound',
'errorMessage' => 'The specified InstanceId does not exist.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\"\\n}","errorExample":""},{"type":"xml","example":"254EB995-DEDF-48A4-9101-9CA5B72FFBCC","errorExample":""}]',
'title' => 'SaveRecording',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListConversations' => [
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'da37319b-6c83-4268-9f19-814aed62e401',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
'maximum' => '100',
'minimum' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '10',
'maximum' => '100',
'minimum' => '1',
],
],
[
'name' => 'CallingNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '138106*****',
],
],
[
'name' => 'Result',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '0',
],
],
[
'name' => 'Query',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '13788914724',
],
],
[
'name' => 'BeginTimeLeftRange',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1638288000000',
],
],
[
'name' => 'BeginTimeRightRange',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1637547875311',
],
],
[
'name' => 'IsSandBox',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RoundsLeftRange',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
],
],
[
'name' => 'RoundsRightRange',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'PageSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'a2c26e67-5984-4935-984e-bcee52971993',
],
'PageNumber' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Conversations' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'EndTime' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1582266750353',
],
'HasToAgent' => [
'type' => 'boolean',
],
'StartTime' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1641625694286',
],
'SkillGroup' => [
'description' => '',
'type' => 'string',
],
'ConversationId' => [
'description' => '',
'type' => 'string',
'example' => '82b2eaae-ce5c-45f8-8231-f15b6b27e55c',
],
'CallingNumber' => [
'description' => '',
'type' => 'string',
'example' => '135815884***',
],
'EndReason' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Rounds' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'HasLastPlaybackCompleted' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'SandBox' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'CalledNumber' => [
'type' => 'string',
],
'DsReport' => [
'type' => 'string',
],
'DsReportTitles' => [
'type' => 'array',
'items' => [
'type' => 'string',
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidParameter',
'errorMessage' => 'The specified parameter %s is invalid.',
],
],
404 => [
[
'errorCode' => 'InvalidInstanceId.NotFound',
'errorMessage' => 'The specified InstanceId does not exist.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"a2c26e67-5984-4935-984e-bcee52971993\\",\\n \\"PageNumber\\": 1,\\n \\"Conversations\\": [\\n {\\n \\"EndTime\\": 1582266750353,\\n \\"HasToAgent\\": false,\\n \\"StartTime\\": 1641625694286,\\n \\"SkillGroup\\": \\"skg-123\\",\\n \\"ConversationId\\": \\"82b2eaae-ce5c-45f8-8231-f15b6b27e55c\\",\\n \\"CallingNumber\\": \\"135815884***\\",\\n \\"EndReason\\": 1,\\n \\"Rounds\\": 2,\\n \\"HasLastPlaybackCompleted\\": true,\\n \\"SandBox\\": true,\\n \\"CalledNumber\\": \\"12356\\",\\n \\"DsReport\\": \\"\\",\\n \\"DsReportTitles\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => 'ListConversations',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'BeginDialogue' => [
'summary' => '开启会话',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'CalledNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '10086',
],
],
[
'name' => 'CallingNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '1358158****',
],
],
[
'name' => 'ConversationId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'c28fc549-d88f-4f6e-85ad-a0806e5e39c0',
],
],
[
'name' => 'InitialContext',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '{\\"channelId\\":\\"fe2559d3-5fc9-4fa5-8314-32b9f762791d\\"}',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '4d7db6670b8e41b5adb1f21560ea9272',
],
],
[
'name' => 'InstanceOwnerId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1231639035307976',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Action' => [
'description' => '',
'type' => 'string',
'example' => 'Broadcast',
],
'Interruptible' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD',
],
'ActionParams' => [
'description' => '',
'type' => 'string',
'example' => '{\\"duration\\":31340,\\"endTime\\":1638243934786,\\"hangUpDirection\\":\\"ivr\\",\\"startTime\\":1638243903446}',
],
'TextResponse' => [
'description' => '',
'type' => 'string',
'example' => '',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'InvalidInstanceId.NotFound',
'errorMessage' => 'The specified InstanceId does not exist.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Action\\": \\"Broadcast\\",\\n \\"Interruptible\\": true,\\n \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\",\\n \\"ActionParams\\": \\"{\\\\\\\\\\\\\\"duration\\\\\\\\\\\\\\":31340,\\\\\\\\\\\\\\"endTime\\\\\\\\\\\\\\":1638243934786,\\\\\\\\\\\\\\"hangUpDirection\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ivr\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"startTime\\\\\\\\\\\\\\":1638243903446}\\",\\n \\"TextResponse\\": \\"您好,欢迎致电智能助手\\"\\n}","type":"json"}]',
],
'ExportConversationDetails' => [
'summary' => 'ExportConversationDetails',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '6c01a99f-1b72-4f75-a8bd-3875766bd19d',
],
],
[
'name' => 'CallingNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '13581588**',
],
],
[
'name' => 'BeginTimeLeftRange',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1582266750353',
],
],
[
'name' => 'BeginTimeRightRange',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1640793599000',
],
],
[
'name' => 'Options',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '{\'Option\': [\'betaTestApproved\']}',
],
'required' => false,
'maxItems' => 99,
],
],
[
'name' => 'RoundsLeftRange',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
],
],
[
'name' => 'RoundsRightRange',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
],
],
[
'name' => 'Result',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '75BAAB9B-40B2-5FF5-A59A-7BCF8154C6EE',
],
'ExportTaskId' => [
'description' => '',
'type' => 'string',
'example' => '6203fc87271a420c98eab6c2bbc2d856',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidParameter',
'errorMessage' => 'The specified parameter %s is invalid.',
],
],
404 => [
[
'errorCode' => 'InvalidInstanceId.NotFound',
'errorMessage' => 'The specified InstanceId does not exist.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75BAAB9B-40B2-5FF5-A59A-7BCF8154C6EE\\",\\n \\"ExportTaskId\\": \\"6203fc87271a420c98eab6c2bbc2d856\\"\\n}","type":"json"}]',
],
'DebugBeginDialogue' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
],
'parameters' => [
[
'name' => 'CalledNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '10086',
],
],
[
'name' => 'CallingNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '135815*****',
],
],
[
'name' => 'ConversationId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '8a503680-815d-473e-a9b0-e010f47a64d2',
],
],
[
'name' => 'InitialContext',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '{}',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '8a503680-815d-473e-a9b0-e010f47a64d2',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Action' => [
'description' => '',
'type' => 'string',
'example' => 'Broadcast',
],
'Interruptible' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD',
],
'ActionParams' => [
'description' => '',
'type' => 'string',
'example' => '{}',
],
'TextResponse' => [
'description' => '',
'type' => 'string',
'example' => '',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'InvalidInstanceId.NotFound',
'errorMessage' => 'The specified InstanceId does not exist.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"TextResponse\\": \\"您好,欢迎致电智能助手\\",\\n \\"ActionParams\\": \\"{}\\",\\n \\"Action\\": \\"Broadcast\\",\\n \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\",\\n \\"Interruptible\\": true\\n}","errorExample":""},{"type":"xml","example":"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\n您好,欢迎致电智能助手\\nfalse\\nBroadcast","errorExample":""}]',
'title' => 'DebugBeginDialogue',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DebugCollectedNumber' => [
'summary' => 'DebugCollectedNumber',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '7cefbff0-8d50-4d6f-b93c-73cee23c1555',
],
],
[
'name' => 'ConversationId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '7cefbff0-8d50-4d6f-b93c-73cee23c1555',
],
],
[
'name' => 'Number',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Action' => [
'description' => '',
'type' => 'string',
'example' => 'Broadcast',
],
'Interruptible' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'abb4aa26-3a8e-43dd-82f8-0c3898c9c67f',
],
'ActionParams' => [
'description' => '',
'type' => 'string',
'example' => '{}',
],
'TextResponse' => [
'description' => '',
'type' => 'string',
'example' => '',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidParameter',
'errorMessage' => 'The specified parameter %s is invalid.',
],
],
404 => [
[
'errorCode' => 'InvalidInstanceId.NotFound',
'errorMessage' => 'The specified InstanceId does not exist.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"TextResponse\\": \\"您好,欢迎致电智能助手\\",\\n \\"ActionParams\\": \\"{}\\",\\n \\"Action\\": \\"Broadcast\\",\\n \\"RequestId\\": \\"abb4aa26-3a8e-43dd-82f8-0c3898c9c67f\\",\\n \\"Interruptible\\": true\\n}","errorExample":""},{"type":"xml","example":"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\n您好,欢迎致电智能助手\\nfalse\\nBroadcast","errorExample":""}]',
'title' => 'DebugCollectedNumber',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DebugDialogue' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
],
'parameters' => [
[
'name' => 'ConversationId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '7cefbff0-8d50-4d6f-b93c-73cee23c1555',
],
],
[
'name' => 'AdditionalContext',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '{}',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'abb4aa26-3a8e-43dd-82f8-0c3898c9c67f',
],
],
[
'name' => 'Utterance',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Action' => [
'description' => '',
'type' => 'string',
'example' => 'Broadcast',
],
'Interruptible' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'd74d6290-7cbe-4436-b5d7-014ebb0f4060',
],
'ActionParams' => [
'description' => '',
'type' => 'string',
'example' => '{}',
],
'TextResponse' => [
'description' => '',
'type' => 'string',
'example' => '80d11be3-faad-4101-b4b0-59dbea28aaf0',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'InvalidInstanceId.NotFound',
'errorMessage' => 'The specified InstanceId does not exist.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"TextResponse\\": \\"80d11be3-faad-4101-b4b0-59dbea28aaf0\\",\\n \\"ActionParams\\": \\"{}\\",\\n \\"Action\\": \\"Broadcast\\",\\n \\"RequestId\\": \\"d74d6290-7cbe-4436-b5d7-014ebb0f4060\\",\\n \\"Interruptible\\": true\\n}","errorExample":""},{"type":"xml","example":"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\n您好,欢迎致电智能助手\\nfalse\\nBroadcast","errorExample":""}]',
'title' => 'DebugDialogue',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreateInstance' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '',
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
[
'name' => 'Concurrency',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '10',
],
],
[
'name' => 'UnionSource',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'UnionInstanceId',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'NluServiceParamsJson',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '9ab43460-c0b9-40e2-8447-48d82c97fc67',
],
'InstanceId' => [
'description' => '',
'type' => 'string',
'example' => 'c28fc549-d88f-4f6e-85ad-a0806e5e39c0',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidConcurrency.LimitExceeded',
'errorMessage' => 'The specified Concurrency exceeds the upper limit.',
],
[
'errorCode' => 'InvalidInstanceName.Duplicated',
'errorMessage' => 'The specified InstanceName already exists.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"InstanceId\\": \\"c28fc549-d88f-4f6e-85ad-a0806e5e39c0\\",\\n \\"RequestId\\": \\"9ab43460-c0b9-40e2-8447-48d82c97fc67\\"\\n}","errorExample":""},{"type":"xml","example":"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\n12f407b22cbe4890ac595f09985848d5","errorExample":""}]',
'title' => 'CreateInstance',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteInstance' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'd74d6290-7cbe-4436-b5d7-014ebb0f4060',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'd74d6290-7cbe-4436-b5d7-014ebb0f4060',
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"d74d6290-7cbe-4436-b5d7-014ebb0f4060\\"\\n}","errorExample":""},{"type":"xml","example":"b19af5ce5314ac08108d1b33fe20e15","errorExample":""}]',
'title' => 'DeleteInstance',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DisableInstance' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'da37319b-6c83-4268-9f19-814aed62e401',
'docRequired' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'InvalidInstanceId.NotFound',
'errorMessage' => 'The specified InstanceId does not exist.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"true\\",\\n \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\"\\n}","errorExample":""},{"type":"xml","example":"14C39896-AE6D-4643-9C9A-E0566B2C2DDD","errorExample":""}]',
'title' => 'DisableInstance',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'EnableInstance' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'da37319b-6c83-4268-9f19-814aed62e401',
'docRequired' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '3a530dc0-7cfa-48f6-9539-bf9001e77b16',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'InvalidInstanceId.NotFound',
'errorMessage' => 'The specified InstanceId does not exist.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"true\\",\\n \\"RequestId\\": \\"3a530dc0-7cfa-48f6-9539-bf9001e77b16\\"\\n}","errorExample":""},{"type":"xml","example":"3a530dc0-7cfa-48f6-9539-bf9001e77b16","errorExample":""}]',
'title' => 'EnableInstance',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ModifyInstance' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '12f407b22cbe4890ac595f09985848d5',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
[
'name' => 'Concurrency',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidConcurrency.LimitExceeded',
'errorMessage' => 'The specified Concurrency exceeds the upper limit.',
],
[
'errorCode' => 'InvalidInstanceName.Duplicated',
'errorMessage' => 'The specified InstanceName already exists.',
],
],
404 => [
[
'errorCode' => 'InvalidInstanceId.NotFound',
'errorMessage' => 'The specified InstanceId does not exist.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\"\\n}","errorExample":""},{"type":"xml","example":"14C39896-AE6D-4643-9C9A-E0566B2C2DDD","errorExample":""}]',
'title' => 'ModifyInstance',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeNavigationConfig' => [
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '287289b6-1510-4e64-9224-39b53ad89dd2',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD',
],
'SilenceTimeoutConfig' => [
'description' => '',
'type' => 'object',
'properties' => [
'Timeout' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'IntentTrigger' => [
'description' => '""',
'type' => 'string',
'example' => '""',
],
'FinalPrompt' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'SourceType' => [
'description' => '',
'type' => 'string',
'example' => 'chatbotIntent',
],
'FinalAction' => [
'description' => '',
'type' => 'string',
'example' => 'HangUp',
],
'Prompt' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Threshold' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'FinalActionParams' => [
'description' => '',
'type' => 'string',
'example' => '{}',
],
],
],
'GreetingConfig' => [
'description' => '',
'type' => 'object',
'properties' => [
'IntentTrigger' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'GreetingWords' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'SourceType' => [
'description' => '',
'type' => 'string',
'example' => 'chatbotIntent',
],
],
],
'UnrecognizingConfig' => [
'description' => '',
'type' => 'object',
'properties' => [
'FinalPrompt' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'FinalAction' => [
'description' => '',
'type' => 'string',
'example' => 'TransferToAgent',
],
'FinalActionParams' => [
'description' => '',
'type' => 'string',
'example' => '{ \\"skillGroupId\\": \\"fallbackSkillGroup\\" }',
],
'Threshold' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'Prompt' => [
'description' => '',
'type' => 'string',
'example' => '',
],
],
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'InvalidInstanceId.NotFound',
'errorMessage' => 'The specified InstanceId does not exist.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\",\\n \\"GreetingConfig\\": {\\n \\"SourceType\\": \\"chatbotIntent\\",\\n \\"IntentTrigger\\": \\"你好\\",\\n \\"GreetingWords\\": \\"您好,欢迎致电智能导航\\"\\n },\\n \\"UnrecognizingConfig\\": {\\n \\"FinalAction\\": \\"TransferToAgent\\",\\n \\"FinalActionParams\\": \\"{ \\\\\\\\\\\\\\"skillGroupId\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"fallbackSkillGroup\\\\\\\\\\\\\\" }\\",\\n \\"Threshold\\": 3,\\n \\"Prompt\\": \\"抱歉,我无法理解您的意思\\",\\n \\"FinalPrompt\\": \\"抱歉,我暂时无法处理您的问题,即将为您转接人工\\"\\n },\\n \\"RepeatingConfig\\": {\\n \\"Utterances\\": [\\n \\" [ \\\\\\"没听清\\\\\\", \\\\\\"再说一遍\\\\\\" ]\\"\\n ]\\n },\\n \\"AskingBackConfig\\": {\\n \\"NegativeFeedbackPrompt\\": \\"感谢您的来电。请您稍后为我的服务做出评价。\\",\\n \\"NegativeFeedbackAction\\": \\"TransferToIVR\\",\\n \\"NegativeFeedbackActionParams\\": \\"{ \\\\\\\\\\\\\\"route\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"satisfaction\\\\\\\\\\\\\\" }\\",\\n \\"EnableNegativeFeedback\\": true,\\n \\"Enabled\\": true,\\n \\"Prompt\\": \\"请问还有什么可以帮您?\\",\\n \\"NegativeFeedbackUtterances\\": [\\n \\" [ \\\\\\"没有了\\\\\\", \\\\\\"不需要了\\\\\\", \\\\\\"不用了,谢谢\\\\\\" ],\\"\\n ]\\n },\\n \\"ComplainingConfig\\": {\\n \\"FinalAction\\": \\"TransferToAgent\\",\\n \\"Prompt\\": \\"好的,即将为您转接人工处理\\",\\n \\"FinalActionParams\\": \\"{ \\\\\\\\\\\\\\"skillGroupId\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"fallbackSkillGroup\\\\\\\\\\\\\\" }\\",\\n \\"Utterances\\": [\\n \\"[ \\\\\\"投诉\\\\\\", \\\\\\"转人工\\\\\\", \\\\\\"有没有人工\\\\\\" ]\\"\\n ]\\n },\\n \\"SilenceTimeoutConfig\\": {\\n \\"Timeout\\": 10,\\n \\"IntentTrigger\\": \\"\\\\\\"\\\\\\"\\",\\n \\"FinalPrompt\\": \\"抱歉,听不到您说话,请您稍后致电\\",\\n \\"SourceType\\": \\"chatbotIntent\\",\\n \\"FinalAction\\": \\"HangUp\\",\\n \\"Prompt\\": \\"抱歉,我没听到您说话\\",\\n \\"Threshold\\": 3,\\n \\"FinalActionParams\\": \\"{}\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\n\\n 您好,欢迎致电智能导航\\n\\n\\n 抱歉,我无法理解您的意思\\n 3\\n 抱歉,我暂时无法处理您的问题,即将为您转接人工\\n TransferToAgent\\n { \\"skillGroupId\\": \\"fallbackSkillGroup\\" }\\n\\n\\n 没听清\\n 再说一遍\\n\\n\\n true\\n 请问还有什么可以帮您?\\n true\\n 没有了\\n 不需要了\\n 不用了,谢谢\\n 感谢您的来电。请您稍后为我的服务做出评价。\\n TransferToIVR\\n { \\"route\\": \\"satisfaction\\" } \\n\\n\\n 抱歉,我没听到您说话\\n 10\\n 3\\n 抱歉,听不到您说话,请您稍后致电\\n HangUp\\n\\n\\n 投诉\\n 转人工\\n 有没有人工\\n 好的,即将为您转接人工处理\\n TransferToAgent\\n { \\"skillGroupId\\": \\"fallbackSkillGroup\\" }\\n","errorExample":""}]',
'title' => 'DescribeNavigationConfig',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeInstance' => [
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ecbfa5e3-1838-4e8a-aa08-fa8b713b82df',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'Drafted',
],
'ModifyTime' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1532436395329',
],
'Description' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD',
],
'InstanceId' => [
'description' => '',
'type' => 'string',
'example' => 'test1_instanceId',
],
'Concurrency' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'ApplicableOperations' => [
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => '',
],
],
'ModifyUserName' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Name' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'AbilityType' => [
'type' => 'string',
],
'UnionSource' => [
'type' => 'string',
],
'UnionInstanceId' => [
'type' => 'string',
],
'NluServiceParamsJson' => [
'type' => 'string',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'InvalidInstanceId.NotFound',
'errorMessage' => 'The specified InstanceId does not exist.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"Published\\",\\n \\"ModifyTime\\": 1683216000000,\\n \\"Description\\": \\"导航测试实例描述信息\\",\\n \\"RequestId\\": \\"790B5EA3-D251-1666-B1E0-4D1F4B33A592\\",\\n \\"InstanceId\\": \\"cd6fc91bc13445c2af7f2e3e31418520\\",\\n \\"Concurrency\\": 10,\\n \\"ApplicableOperations\\": [\\n \\"Edit\\"\\n ],\\n \\"ModifyUserName\\": \\"2508711*******\\",\\n \\"Name\\": \\"导航测试实例\\",\\n \\"AbilityType\\": \\"VOICE_ONLY\\",\\n \\"UnionSource\\": \\"\\",\\n \\"UnionInstanceId\\": \\"\\",\\n \\"NluServiceParamsJson\\": \\"\\"\\n}","errorExample":""},{"type":"xml","example":"\\n Published\\n 1683216000000\\n 导航测试实例描述信息\\n 790B5EA3-D251-1666-B1E0-4D1F4B33A592\\n cd6fc91bc13445c2af7f2e3e31418520\\n 10\\n Edit\\n 2508711*******\\n 导航测试实例\\n VOICE_ONLY\\n","errorExample":""}]',
'title' => 'DescribeInstance',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeStatisticalData' => [
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'c28fc549-d88f-4f6e-85ad-a0806e5e39c0',
],
],
[
'name' => 'TimeUnit',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'Day/Hour',
],
],
[
'name' => 'BeginTimeLeftRange',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1582283640000',
],
],
[
'name' => 'BeginTimeRightRange',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1582298040000',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'TotalDialoguePassRate' => [
'description' => '',
'type' => 'string',
'example' => '80.00%',
],
'TotalKnowledgeHitRate' => [
'description' => '',
'type' => 'string',
'example' => '80.00%',
],
'TotalResolutionRate' => [
'description' => '',
'type' => 'string',
'example' => '80.00%',
],
'TotalValidAnswerRate' => [
'description' => '',
'type' => 'string',
'example' => '80.00%',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD',
],
'ResolvedQuestionTotalNum' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '80',
],
'ConversationTotalNum' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'StatisticalDataReports' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'KnowledgeHitRate' => [
'description' => '',
'type' => 'string',
'example' => '80.00%',
],
'ResolvedQuestionNum' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '80',
],
'ResolutionRate' => [
'description' => '',
'type' => 'string',
'example' => '80.00%',
],
'StatisticalDate' => [
'description' => '',
'type' => 'string',
'example' => '19:00:00',
],
'TotalConversationNum' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'ValidAnswerRate' => [
'description' => '',
'type' => 'string',
'example' => '80.0',
],
'DialoguePassRate' => [
'description' => '',
'type' => 'string',
'example' => '80.00%',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidParameter',
'errorMessage' => 'The specified parameter %s is invalid.',
],
],
404 => [
[
'errorCode' => 'InvalidInstanceId.NotFound',
'errorMessage' => 'The specified InstanceId does not exist.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"ConversationTotalNum\\": 100,\\n \\"TotalDialoguePassRate\\": \\"80.00%\\",\\n \\"TotalKnowledgeHitRate\\": \\"80.00%\\",\\n \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\",\\n \\"TotalValidAnswerRate\\": \\"80.00%\\",\\n \\"ResolvedQuestionTotalNum\\": 80,\\n \\"TotalResolutionRate\\": \\"80.00%\\",\\n \\"StatisticalDataReports\\": [\\n {\\n \\"KnowledgeHitRate\\": \\"80.00%\\",\\n \\"ResolvedQuestionNum\\": 80,\\n \\"ResolutionRate\\": \\"80.00%\\",\\n \\"StatisticalDate\\": \\"19:00:00\\",\\n \\"TotalConversationNum\\": 100,\\n \\"ValidAnswerRate\\": \\"80.0\\",\\n \\"DialoguePassRate\\": \\"80.00%\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\n100\\n80\\n80.00%\\n80.00%\\n\\n 80\\n 80.00%\\n 100\\n 80.00%\\n 80.00%\\n 80.00%\\n 19:00:00\\n\\n80.00%\\n80.00%","errorExample":""}]',
'title' => 'DescribeStatisticalData',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListInstances' => [
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '10',
],
],
[
'name' => 'NluServiceTypeListJsonString',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '[Managed]',
],
],
[
'name' => 'UnionSource',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'UnionInstanceId',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'Number',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'InstanceIdListJsonString',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Instances' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'Published',
],
'ModifyUserName' => [
'description' => '',
'type' => 'string',
'example' => 'xxx',
],
'Description' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'ApplicableOperations' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => '["Edit", "Publish", "Duplicate", "Delete", "ListHistories"]',
],
],
'InstanceId' => [
'description' => '',
'type' => 'string',
'example' => 'dc437bba-5a25-4bbc-b4c2-f268864bebb5',
],
'Name' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Concurrency' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'ModifyTime' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1582266750353',
],
'Numbers' => [
'type' => 'array',
'items' => [
'type' => 'string',
],
],
'CreateTime' => [
'type' => 'integer',
'format' => 'int64',
],
'UnionSource' => [
'type' => 'string',
],
'UnionInstanceId' => [
'type' => 'string',
],
'NluServiceParamsJson' => [
'type' => 'string',
],
],
],
],
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'A8AED3C8-F57B-5D71-9A34-4A170287533F',
],
'PageNumber' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidParameter',
'errorMessage' => 'The specified parameter %s is invalid.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Instances\\": [\\n {\\n \\"Status\\": \\"Published\\",\\n \\"ModifyUserName\\": \\"xxx\\",\\n \\"Description\\": \\"测试的实例\\",\\n \\"ApplicableOperations\\": [\\n \\"Edit\\"\\n ],\\n \\"InstanceId\\": \\"dc437bba-5a25-4bbc-b4c2-f268864bebb5\\",\\n \\"Name\\": \\"测试实例\\",\\n \\"Concurrency\\": 10,\\n \\"ModifyTime\\": 1582266750353,\\n \\"Numbers\\": [\\n \\"021xxxxxxxx\\\\t\\\\n\\\\n\\\\n\\"\\n ],\\n \\"CreateTime\\": 1658202465000,\\n \\"UnionSource\\": \\"CCC\\",\\n \\"UnionInstanceId\\": \\"zhyl\\\\t\\",\\n \\"NluServiceParamsJson\\": \\"{\\\\\\"agentId\\\\\\":\\\\\\"1213503\\\\\\",\\\\\\"isCCCAgent\\\\\\":\\\\\\"true\\\\\\",\\\\\\"agentKey\\\\\\":\\\\\\"107e04a7519243eb83c9b549ea3b6829_p_ccc_public\\\\\\"}\\\\t\\"\\n }\\n ],\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"A8AED3C8-F57B-5D71-9A34-4A170287533F\\",\\n \\"PageNumber\\": 2\\n}","type":"json"}]',
],
'ListChatbotInstances' => [
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'af81a389-91f0-4157-8d82-720edd02b66a',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
],
[
'name' => 'UnionSource',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'NluServiceType',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'NluServiceParamsJson',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'Bots' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Introduction' => [
'type' => 'string',
'example' => '‘’',
],
'Avatar' => [
'description' => '',
'type' => 'string',
'example' => 'https://dss0.ali.com/70cFuHS.jpg',
],
'TimeZone' => [
'description' => '',
'type' => 'string',
'example' => 'UTC+8',
],
'CreateTime' => [
'description' => '',
'type' => 'string',
'example' => '1582266750353',
],
'LanguageCode' => [
'description' => '',
'type' => 'string',
'example' => 'zh-cn',
],
'InstanceId' => [
'description' => '',
'type' => 'string',
'example' => 'af81a389-91f0-4157-8d82-720edd02b66a',
],
'Name' => [
'description' => '',
'type' => 'string',
'example' => '',
],
],
],
],
'PageSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'da37319b-6c83-4268-9f19-814aed62e401',
],
'PageNumber' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 10,\\n \\"Bots\\": [\\n {\\n \\"Introduction\\": \\"‘’\\",\\n \\"Avatar\\": \\"https://dss0.ali.com/70cFuHS.jpg\\",\\n \\"TimeZone\\": \\"UTC+8\\",\\n \\"CreateTime\\": \\"1582266750353\\",\\n \\"LanguageCode\\": \\"zh-cn\\",\\n \\"InstanceId\\": \\"af81a389-91f0-4157-8d82-720edd02b66a\\",\\n \\"Name\\": \\"测试机器人\\"\\n }\\n ],\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"da37319b-6c83-4268-9f19-814aed62e401\\",\\n \\"PageNumber\\": 1\\n}","errorExample":""},{"type":"xml","example":"da37319b-6c83-4268-9f19-814aed62e401\\n\\n alibaba.com/skjdnvkdsvdk.jpg\\n 1582270782552\\n \\n zh-cn\\n 测试\\n UTC+8\\n","errorExample":""}]',
'title' => 'ListChatbotInstances',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreateDownloadUrl' => [
'summary' => 'CreateDownloadUrl',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'DownloadTaskId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '073f092da0a847b9bf76eb88b5931c7a',
],
],
[
'name' => 'FileId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '22626c39603744f5a08d4d715315561a',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'FileHttpUrl' => [
'description' => '',
'type' => 'string',
'example' => 'http://ssml-test.oss-cn-shanghai.aliyuncs.com/key',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '7401D698-0AAC-5909-B68E-88C68805FFB8',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'True',
],
'Code' => [
'description' => '',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'get upload tool url success',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"FileHttpUrl\\": \\"http://ssml-test.oss-cn-shanghai.aliyuncs.com/key\\",\\n \\"RequestId\\": \\"7401D698-0AAC-5909-B68E-88C68805FFB8\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"get upload tool url success\\"\\n}","type":"json"}]',
],
'ListDownloadTasks' => [
'summary' => '下载列表',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '1000',
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '50',
'minimum' => '1',
'example' => '5',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'successful',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'D24E0148-6D40-550E-9471-B2C5A34C3D12',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'True',
],
'DownloadTasks' => [
'description' => '',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'List' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'Expired',
],
'Title' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'ExpireTime' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1637119221702',
],
'TaskId' => [
'description' => '',
'type' => 'string',
'example' => 'cb9aba69-f578-42b2-aa2f-3e5a41947db8',
],
'DownloadTaskFiles' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'Published',
],
'Title' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Progress' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '70',
],
'FileId' => [
'description' => '',
'type' => 'string',
'example' => 'c32bf5675b704dc5b19200a89d2e85f1',
],
],
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"D24E0148-6D40-550E-9471-B2C5A34C3D12\\",\\n \\"Success\\": true,\\n \\"DownloadTasks\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 2,\\n \\"List\\": [\\n {\\n \\"Status\\": \\"Expired\\",\\n \\"Title\\": \\"批量高阶内存整理_2022_02_17_10\\",\\n \\"ExpireTime\\": 1637119221702,\\n \\"TaskId\\": \\"cb9aba69-f578-42b2-aa2f-3e5a41947db8\\",\\n \\"DownloadTaskFiles\\": [\\n {\\n \\"Status\\": \\"Published\\",\\n \\"Title\\": \\"CBU阿里通信反馈-声音延迟\\",\\n \\"Progress\\": 70,\\n \\"FileId\\": \\"c32bf5675b704dc5b19200a89d2e85f1\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ModifyAsrConfig' => [
'summary' => '修改Asr配置',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'EntryId',
'in' => 'query',
'schema' => [
'title' => 'config_level对应的实体ID',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '6cc9f5ca-2cb6-4cc7-a46b-2bbfd3e61b22',
],
],
[
'name' => 'ConfigLevel',
'in' => 'query',
'schema' => [
'title' => '策略级别,包含 0:系统,1:租户,2:实例',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
'default' => '0',
],
],
[
'name' => 'AsrVocabularyId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '6cc9f5ca-2cb6-4cc7-a46b-2bbfd3e61b22',
],
],
[
'name' => 'AsrCustomizationId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '6cc9f5ca-2cb6-4cc7-a46b-2bbfd3e61b22',
],
],
[
'name' => 'AsrAcousticModelId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '6cc9f5ca-2cb6-4cc7-a46b-2bbfd3e61b22',
],
],
[
'name' => 'AsrClassVocabularyId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '6cc9f5ca-2cb6-4cc7-a46b-2bbfd3e61b22',
],
],
[
'name' => 'Engine',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'NlsServiceType',
'in' => 'query',
'schema' => [
'title' => 'NluServiceType',
'type' => 'string',
'example' => '语音识别',
],
],
[
'name' => 'AppKey',
'in' => 'query',
'schema' => [
'title' => '引擎的AppKey',
'type' => 'string',
'example' => 'your_app_key',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'RpcResponse',
'description' => 'RpcResponse',
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'True',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'AffectedRows' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
],
],
'title' => '影响的行数',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'da37319b-6c83-4268-9f19-814aed62e401',
],
'HttpStatusCode' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '',
'type' => 'string',
'example' => 'OK',
],
'ErrorMsg' => [
'description' => '',
'type' => 'string',
'example' => 'Not Found',
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"AffectedRows\\": 0\\n },\\n \\"RequestId\\": \\"da37319b-6c83-4268-9f19-814aed62e401\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"ErrorMsg\\": \\"Not Found\\"\\n}","type":"json"}]',
],
'GetAsrConfig' => [
'summary' => '获取Asr配置',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'EntryId',
'in' => 'query',
'schema' => [
'title' => 'config_level对应的实体ID',
'description' => '',
'type' => 'string',
'required' => false,
'example' => '3b1d3031-8b6e-460a-8640-d330f2ca50b8',
],
],
[
'name' => 'ConfigLevel',
'in' => 'query',
'schema' => [
'title' => '策略级别,包含 0:系统,1:租户,2:实例',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
'default' => '0',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'RpcResponse',
'description' => 'RpcResponse',
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'True',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'AsrVocabularyId' => [
'description' => '',
'type' => 'string',
'example' => '3b1d3031-8b6e-460a-8640-d330f2ca50b8',
],
'AsrCustomizationId' => [
'description' => '',
'type' => 'string',
'example' => '3b1d3031-8b6e-460a-8640-d330f2ca50b8',
],
'AsrAcousticModelId' => [
'description' => '',
'type' => 'string',
'example' => '3b1d3031-8b6e-460a-8640-d330f2ca50b8',
],
'AsrClassVocabularyId' => [
'description' => '',
'type' => 'string',
'example' => '3b1d3031-8b6e-460a-8640-d330f2ca50b8',
],
'Engine' => [
'title' => '语音引擎',
'type' => 'string',
'example' => 'ali',
],
'EngineXufei' => [
'title' => '讯飞引擎参数',
'type' => 'string',
'example' => 'EngineXufei',
],
'NlsServiceType' => [
'title' => 'NluServiceType',
'type' => 'string',
'example' => 'Authorized',
],
'AppKey' => [
'title' => '引擎',
'type' => 'string',
'example' => 'your-app-key',
],
],
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD',
],
'HttpStatusCode' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '',
'type' => 'string',
'example' => 'OK',
],
'ErrorMsg' => [
'description' => '',
'type' => 'string',
'example' => 'Not Found',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"AsrVocabularyId\\": \\"3b1d3031-8b6e-460a-8640-d330f2ca50b8\\",\\n \\"AsrCustomizationId\\": \\"3b1d3031-8b6e-460a-8640-d330f2ca50b8\\",\\n \\"AsrAcousticModelId\\": \\"3b1d3031-8b6e-460a-8640-d330f2ca50b8\\",\\n \\"AsrClassVocabularyId\\": \\"3b1d3031-8b6e-460a-8640-d330f2ca50b8\\",\\n \\"Engine\\": \\"ali\\",\\n \\"EngineXufei\\": \\"EngineXufei\\",\\n \\"NlsServiceType\\": \\"Authorized\\",\\n \\"AppKey\\": \\"your-app-key\\"\\n },\\n \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"ErrorMsg\\": \\"Not Found\\"\\n}","type":"json"}]',
],
'GetRealTimeConcurrency' => [
'summary' => 'GetRealTimeConcurrency',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'c112c168ed664c0a851f9ca72d2f7999',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'E6E61E1A-D2DC-5ACF-AED4-A115B6691F98',
],
'Timestamp' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1661584255029',
],
'RealTimeConcurrency' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'MaxConcurrency' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E6E61E1A-D2DC-5ACF-AED4-A115B6691F98\\",\\n \\"Timestamp\\": 1661584255029,\\n \\"RealTimeConcurrency\\": 1,\\n \\"MaxConcurrency\\": 2\\n}","type":"json"}]',
],
],
'endpoints' => [
[
'regionId' => 'cn-hangzhou',
'endpoint' => 'voicenavigator.cn-hangzhou.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai',
'endpoint' => 'voicenavigator.cn-shanghai.aliyuncs.com',
],
],
];