Integrate the SDK

1. Log on to SDK Center and select the product for the API you want to call, such as Short Message Service (SMS).

2. On the Installation page, set SDK Generation to V2.0, and set All Languages to TypeScript. Then, on the Quick Start tab, you can find the SDK installation instructions for Short Message Service (SMS).

File upload with Advance operations

Some APIs (such as image search and Visual Intelligence) do not accept local file paths directly. Use the Advance operation to upload files via a stream. The SDK stores the file temporarily in an OSS bucket in the cn-shanghai region, and the service reads it from there. This example uses the DetectBodyCount operation of Visual Intelligence API.

1. Initialize the request client

   Set both regionId and endpoint to the same region. The regionId determines where the temporary OSS file is stored. If you omit regionId, a region mismatch between the product and the OSS bucket causes timeouts.

   TypeScript example

   function createClient(): facebody20191230 {
       let config = new $OpenApi.Config({
           // Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_ID environment variable is set.
           accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
           // Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variable is set.
           accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
       });
       // The endpoint and regionId must be for the same region.
       config.regionId = 'cn-shanghai';
       config.endpoint = 'facebody.cn-shanghai.aliyuncs.com';
       return new facebody20191230(config);
   }

   Node.js example

   function createClient() {
     let config = new OpenApi.Config({
       // Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_ID environment variable is set.
       accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
       // Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variable is set.
       accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
     });
     // The endpoint and regionId must be for the same region.
     config.regionId = 'cn-shanghai';
     config.endpoint = 'facebody.cn-shanghai.aliyuncs.com';
     return new facebody20191230.default(config);
   }

2. Create the request object

   Create a <OpenAPIName>AdvanceRequest object to pass the file stream. The parameter name for the file stream is ImageURLObject.

   TypeScript example

       // Read the file as a file stream.
       const filePath = '<FILE_PATH>';  // Replace this with the actual file path.
       // Check if the file exists.
       if (!fs.existsSync(filePath)) {
           console.error('File does not exist:', filePath);
           return;
       }
       // Create a stream and listen for stream errors.
       const fileStream = fs.createReadStream(filePath).on('error', (err) => {
           console.error('Stream error:', err);
           process.exit(1);
       });
   
       let detectBodyCountAdvanceRequest = new $facebody20191230.DetectBodyCountAdvanceRequest({
         imageURLObject: fileStream,
       });

   Node.js example

       // Read the file as a file stream.
       const filePath = '<FILE_PATH>';  // Replace this with the actual file path.
       // Check if the file exists.
       if (!fs.existsSync(filePath)) {
           console.error('File does not exist:', filePath);
           return;
       }
       // Create a stream and listen for stream errors.
       const fileStream = fs.createReadStream(filePath).on('error', (err) => {
           console.error('Stream error:', err);
           process.exit(1);
       });
   
       let detectBodyCountAdvanceRequest = new facebody20191230.DetectBodyCountAdvanceRequest({
           imageURLObject: fileStream,
       });

3. Send the request

   Call the <operationName>Advance function to send the request.

   TypeScript example

   // Configure runtime parameters.
   let runtime = new $Util.RuntimeOptions({ });
   let client = Client.createClient();
   // Send the request.
   await client.detectBodyCountAdvance(detectBodyCountAdvanceRequest, runtime);

   Node.js example

    // Configure runtime parameters.
    let runtime = new Util.RuntimeOptions({ });
    let client = Client.createClient();
    // Send the request.
    await client.detectBodyCountAdvance(detectBodyCountAdvanceRequest, runtime);  

import { default as facebody20191230 } from '@alicloud/facebody20191230';
import * as $facebody20191230 from '@alicloud/facebody20191230';
import * as $OpenApi from '@alicloud/openapi-client';
import * as $Util from '@alicloud/tea-util';
import * as fs from "fs";

export default class Client {
    static createClient(): facebody20191230 {
        let config = new $OpenApi.Config({
            // Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_ID environment variable is set.
            accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
            // Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variable is set.
            accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
        });
        config.regionId = 'cn-shanghai';
        config.endpoint = 'facebody.cn-shanghai.aliyuncs.com';
        return new facebody20191230(config);
    }

    static async main(): Promise<void> {
        let client = Client.createClient();

        // Read the file as a file stream.
        const filePath = '<FILE_PATH>';  // Replace this with the actual file path.
        // Check if the file exists.
        if (!fs.existsSync(filePath)) {
            console.error('File does not exist:', filePath);
            return;
        }
        // Create a stream and listen for stream errors.
        const fileStream = fs.createReadStream(filePath).on('error', (err) => {
            console.error('Stream error:', err);
            process.exit(1);
        });

        let detectBodyCountAdvanceRequest = new $facebody20191230.DetectBodyCountAdvanceRequest({
            imageURLObject: fileStream,
        });
        let runtime = new $Util.RuntimeOptions({});
        try {
            // Send the request.
            const res = await client.detectBodyCountAdvance(detectBodyCountAdvanceRequest, runtime);
            console.log(res);
        } catch (error) {
            if (error instanceof Error) {
                console.error('Error message:', error.message);
                const data = (error as any)?.data?.Recommend;
                if (typeof data === 'string') {
                    console.log('Diagnostic suggestion:', data);
                }
            }
        }
    }
}

Client.main();

'use strict';
const facebody20191230 = require('@alicloud/facebody20191230');
const OpenApi = require('@alicloud/openapi-client');
const Util = require('@alicloud/tea-util');
const fs = require('fs');

class Client {
  static createClient() {
    let config = new OpenApi.Config({
      // Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_ID environment variable is set.
      accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
      // Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variable is set.
      accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
    });
    config.regionId = 'cn-shanghai';
    config.endpoint = 'facebody.cn-shanghai.aliyuncs.com';
    return new facebody20191230.default(config);
  }

  static async main() {
    let client = Client.createClient();
    // Read the file as a file stream.
    const filePath = '<FILE_PATH>';  // Replace this with the actual file path.
    // Check if the file exists.
    if (!fs.existsSync(filePath)) {
      console.error('File does not exist:', filePath);
      return;
    }
    // Create a stream and listen for stream errors.
    const fileStream = fs.createReadStream(filePath).on('error', (err) => {
      console.error('Stream error:', err);
      process.exit(1);
    });
    // Configure request parameters.
    let detectBodyCountAdvanceRequest = new facebody20191230.DetectBodyCountAdvanceRequest({
      imageURLObject: fileStream,
    });
    let runtime = new Util.RuntimeOptions({});
    try {
      // Send the request.
      const res = await client.detectBodyCountAdvance(detectBodyCountAdvanceRequest, runtime);
      console.log(res);
    } catch (error) {
      // This is for demonstration purposes only. Handle exceptions with care. Do not ignore exceptions in your project.
      console.log(error);
    }
  }
}

exports.Client = Client;
Client.main();

FAQ

1. "You are not authorized to perform this operation" error when calling an API

   Cause and solution

   Cause: The RAM user associated with your AccessKey does not have the required permissions to call the API.

   Solution: Grant the required API permissions to the RAM user. See Manage RAM user permissions.

   For example, if you receive this error when calling SendSms or , you can create the following custom permission policy and attach it to the RAM user.

   {
     "Version": "1",
     "Statement": [
       {
         "Effect": "Allow",
         "Action": "dysms:SendSms",
         "Resource": "*"
       }
     ]
   }

2. "triggerUncaughtException Error: getaddrinfo ENOTFOUND" error (endpoint issue)

   Cause and solution

   Cause: The specified endpoint is not supported by the OpenAPI operation that you are calling.

   Solution: Fix the endpoint using Endpoint configuration and retry.

3. "Cannot read properties of undefined (reading 'getCredential')" or "InvalidAccessKeyId.NotFound: code: 404" error

   Cause and solution

   Cause: The AccessKey was not passed correctly.

   Solution: Verify that the AccessKey is passed correctly during client initialization. process.env("XXX") reads the value of XXX from environment variables.

For other common errors, see FAQ.