Quick Start

Prepare your account

1. Register an Alibaba Cloud account. For more information, see Register an Alibaba Cloud account.

2. Complete individual identity verification. For more information, see Individual identity verification.

3. (This step is required only if you use legacy APIs) Create and authorize a Resource Access Management (RAM) user. For more information, see Create a RAM user. For more information about RAM users, see What is Resource Access Management?. Contact the Alibaba Cloud account owner to grant the required permissions in the RAM console. When you use the Tingwu console, you must have permissions to read the list of Object Storage Service (OSS) buckets. If a RAM user does not have this permission, an error appears, as shown in the following figure:

   1. In the RAM console, navigate to Permission Management > Policies and create a custom policy. The policy configuration is as follows:

      {
          "Version": "1",
          "Statement": [
              {
                  "Effect": "Allow",
                  "Action": "oss:ListBuckets",
                  "Resource": "acs:oss:*:*:*"
              }
          ]
      }

   2. In the RAM console, navigate to Identity Management > Users. Find the target RAM user. In the Actions column, click Add Permissions. Select the custom policy that you created in the previous step and the AliyunTingwuFullAccess system policy to grant permissions to the RAM user.

Create an AccessKey

1. Create an AccessKey for an Alibaba Cloud account

   Log on to the RAM console and create an AccessKey for your Alibaba Cloud account. For more information, see Create an AccessKey.

2. Create an AccessKey for a RAM user (Optional)

   Log on to the RAM console with your Alibaba Cloud account and create an AccessKey for the RAM user. For more information, see Create an AccessKey

   

Activate the service

1. Log on to the Tingwu console.

2. On the Overview page, click Activate Now.

3. On the Product Activation page, select a service type.

   1. Select Trial. New users are eligible for a 90-day free trial.

   2. Select Commercial. After activation, you are charged for the Tingwu API service based on the duration of your API requests. The fees are deducted from your Alibaba Cloud account balance based on your actual usage.

   Note

   For more information about the billing rules for the commercial version, see Billing overview.

   Service Capabilities	Benefits during the free trial	How to continue using the service after the trial
   Real-time recording	Concurrent real-time streams: 2.	On the Service Management and Activation page, upgrade the Real-time Recording service to the commercial version. After you upgrade, the service is billed on a pay-as-you-go basis by duration. Concurrent real-time streams for the commercial version: 200
   Audio and video file recording	File upload: 2 hours of free quota per day (audio duration). After the daily free quota is used up, you must wait 24 hours to continue using the service.	On the Service Management and Activation page, upgrade the Audio and Video File Recording service to the commercial version. After you upgrade, the service is billed on a pay-as-you-go basis by duration.

Create a project

1. In the Tingwu console, click My Projects in the left navigation pane.

2. On the My Projects page, click Create Project. If this is your first project, you can also click Create Now.

   

   1. Enter a project name.

   2. Select a callback method.

      • If you select the HTTP POST protocol, enter a URL. Tingwu sends a POST request to the configured URL. If the HTTP status code 200 is returned, the configuration is verified.

      • If you select Event Bus, you must activate the Alibaba Cloud EventBridge service.

      • If you select No Callback, Poll Manually, you must call the polling API.

   3. Select an Object Storage Service bucket (required only for legacy APIs). If the bucket you need is not in the drop-down list, click Create OSS Bucket on the right.

      Tingwu writes a test file named tingwu/initfile.txt to the configured OSS bucket. If the file is written successfully, the configuration is verified.

      Note

      The bucket and the project must be in the same region. Cross-region data storage may reduce the success rate. For each request, Tingwu writes the processing results to an object that starts with "tingwu" in this bucket.

   4. When you configure OSS, the Tingwu service automatically checks your RAM user permissions. If the required permissions are not granted, contact the Alibaba Cloud account owner to perform the operations described in Step 3 of the "Prepare your account" section.

   5. Enter a project description (optional).

Test the effect (optional)

1. On the My Projects page of the Tingwu console, find your project and click Service Test in the Actions column.

   

2. Test the recognition accuracy for Chinese, English, and Cantonese.

   1. If you select Chinese/English/Cantonese as the test language, select Microphone Input as the test method, and click Start Recording. The real-time transcription results are displayed. The recognition process stops automatically after 60 s. Click Confirm to return to the project list page.

      

   2. If you select Chinese/English/Cantonese as the test language, select Audio File as the test method, and click Upload Local File. After the file is uploaded, you can view the transcription results. The uploaded audio file can be played online. Click Confirm to return to the project list page. For a free visual test of more languages, Large Language Models (LLMs), and translation features, go to the Tingwu website.

      

Developer integration

After you complete the preceding steps, you will have the AccessKey ID, AccessKey secret, and project AppKey for your account. Make sure that these credentials belong to the same Alibaba Cloud account or RAM user.