Alibaba Cloud Model Studio:Non-real-time speech recognition (Fun-ASR-Flash) iOS SDK

url

String

Yes

Service endpoints:

• wss://dashscope.aliyuncs.com/api/v1/services/aigc/multimodal-generation/generation

• China (Beijing): wss://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/services/aigc/multimodal-generation/generation

• Singapore: wss://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/aigc/multimodal-generation/generation

Replace {WorkspaceId} with your actual Workspace ID.

apikey

String

Yes

API Key.

service_mode

String

Yes

The operating mode. For non-real-time speech recognition, set this parameter to "1".

device_id

String

Yes

A unique string that identifies the end user. You can use an in-app user ID or a client-generated unique device identifier. This ID is mainly used for log tracing and troubleshooting.

debug_path

String

No

The path for log files. This parameter takes effect only when you call nui_initialize with save_log set to YES. In this case, you must specify the log file path. Otherwise, an error occurs. Up to two log files are retained locally.

max_log_file_size

int

No

The maximum log file size in bytes. This parameter takes effect only when you call nui_initialize with save_log set to YES. Default: 104857600 (100 * 1024 * 1024 bytes, or 100 MiB).

log_track_level

int

No

The filtering level for logs sent through the logging callback (onFileTransLogTrackCallback). Default: 2. Valid values:

• 0: LOG_LEVEL_VERBOSE
• 1: LOG_LEVEL_DEBUG
• 2: LOG_LEVEL_INFO
• 3: LOG_LEVEL_WARNING
• 4: LOG_LEVEL_ERROR
• 5: LOG_LEVEL_NONE (disables this feature).

apikey

string

No

If Connection and control parameters apikey uses temporary API key, you can update it here to prevent expiration.

nls_config

object

Yes

The core speech recognition configuration object, including the model and parameters that control recognition.

nls_config.model

string

Yes

The model name.

nls_config.format

string

Yes

The audio format. Set this parameter to the actual format. Supported formats include wav, mp3, opus. For details, see Audio specifications.

nls_config.sample_rate

string

No

The audio sample rate in Hz. For example, 16000 indicates a sample rate of 16 kHz. For details, see Audio specifications.

nls_config.vocabulary_id

string

No

The precompiled vocabulary ID. Create a vocabulary in advance and pass its ID during recognition to use its hotwords. Use this option when the vocabulary is known, relatively stable, and reused across requests. For usage instructions, see Precompiled hotwords.

nls_config.language_hints

array[string]

No

The language codes to recognize. If the language is unknown in advance, omit this parameter to let the model detect it automatically. You can set up to 1 value. If you set more, only the first 1 take effect.

messages

array[object]

Yes

The list of messages. It contains the audio to recognize and optional conversation context to improve recognition.

role

string

Yes

The message role. Valid values:

• user (required): A user message. When type is input_audio, it represents the audio to recognize. When type is input_text, it represents recognition results from previous turns or a domain-specific vocabulary (optional context).

• assistant (optional context): Large language model responses from previous turns.

content

array[object]

Yes

The list of message content. See the following descriptions.

type

string

Yes

The content type. Each request requires at least one input_audio message. Valid values:

• input_audio (required): The audio input to recognize (role is user). You must also provide the input_audio object.

• input_text (optional context): Recognition results of user speech from previous turns or a domain-specific vocabulary (role is user). You must also provide the text field.

• text (optional context): Large language model responses from previous turns (role is assistant). You must also provide the text field.

input_audio

object

No

Required when type is input_audio.

input_audio.data

string

Yes

The audio data to recognize. For supported audio formats, file size limits, duration limits, and other input requirements, see Audio specifications. The following two input methods are supported:

• Audio file URL: Pass a publicly accessible audio file URL.

• Base64 Data URI: Pass Base64-encoded audio as a Data URI. Concatenate the data:{MIME_TYPE};base64, prefix with the Base64-encoded audio data. Supported MIME types include audio/wav, audio/mp3.

Example (URL): https://example.com/audio/sample.wav

Example (Base64): data:audio/wav;base64,{BASE64_ENCODED_DATA}

text

string

No

Required when type is input_text, provide recognition results of user speech from previous turns or a domain-specific vocabulary. When type is text, provide large language model responses from previous turns. Text length is counted in characters, with each character counting as one. The total length of all messages' text fields in each context turn must not exceed 400 characters. Excess characters are truncated from the end.

parameters

char*

A JSON string containing authentication, connection, and debugging parameters. See Connection and control parameters.

level

NuiSdkLogLevel

The level of logs printed by the SDK.

save_log

BOOL

Whether to save logs locally. If set to YES, use Connection and control parameters to set debug_path to specify the path, and use max_log_file_size to set the file size.

params

char*

Recognition parameters in nls_config and messages parameters.

Example:

{
  "messages": [
    {
      "content": [
        {
          "input_audio": {
            "data": "{YOUR_AUDIO_URL}"
          },
          "type": "input_audio"
        }
      ],
      "role": "user"
    }
  ],
  "nls_config": {
    "format": "mp3",
    "model": "fun-asr-flash-2026-06-15"
  }
}

params

char*

Recognition parameters. Example:

{
  "messages": [
    {
      "role": "user",
      "content": [
        {
          "type": "input_audio",
          "input_audio": {
            "data": "{YOUR_AUDIO_URL}"
          }
        }
      ]
    }
  ],
  "nls_config": {
    "format": "mp3",
    "model": "fun-asr-flash-2026-06-15"
  }
}

task_id

char*

You can ignore this parameter and pass null.

task_id

char*

The ID of the task to query, obtained from EVENT_FILE_TRANS_UPLOADED.

task_id

char*

The ID of the task to cancel, obtained from EVENT_FILE_TRANS_UPLOADED.

nuiEvent

NuiCallbackEvent

The callback event.

asr_result

char*

The speech recognition result.

task_id

char*

The task ID.

finish

BOOL

Whether recognition for this turn has finished.

code

int

Valid only when the EVENT_ASR_ERROR event occurs.

EVENT_FILE_TRANS_CONNECTED

Successfully connected to the service.

EVENT_FILE_TRANS_UPLOADED

The audio file was uploaded successfully. You can obtain the current task_id at this point.

EVENT_FILE_TRANS_RESULT

The final recognition result.

EVENT_ASR_ERROR

An error occurred during speech recognition.