Node.js SDK guide

Steps

1. You have initialized the SDK client. For more information, see SDK Initialization.

2. Create an instance of the ${API name}+"Request" class for the target API and name the instance request.

3. Use the request object to set the required request parameters for the API.

4. Create an instance of the ${API name}+"Response" class named response. Call the ${API name}(request) method of the client object to send the request. The response includes the body and headers from the server.

5. Access specific return parameters through the response.body.${return parameter name} property.

   For example, response.body.success indicates whether the call succeeded. Other common return parameters include RequestId, ErrorMessage, and Code.

6. Use the catch() method to handle exceptions.

For more information about IoT Platform cloud APIs, see API list. For descriptions of the request parameters in the request and the response parameters in the response, see the documentation for the specific API.

This topic uses the Pub API as an example to show how to publish a message to a topic. For information about request parameters, see Pub.

try {
    let client = Client.createClient("${accessKey}", "${accessKeySecret}");
    let request = new $Iot.PubRequest({
        // The ID of the IoT Platform instance.
        iotInstanceId: "${iotInstanceId}",
        // The ProductKey of the product.
        productKey: "${productKey}",
        // The message body to send. The value must be Base64-encoded.
        messageContent: "eyJ0ZXN0IjoidGFzayBwdWIgYnJvYWRjYXN0In0=",
        // The custom topic of the device that receives the message.
        topicFullName: "/${productKey}/${deviceName}/user/get",
        // The method to send the message. QoS 0 and QoS 1 are supported.
        qos: 0,
    });
    let response = await client.pub(request);
    Console.log(Util.toJSONString($tea.toMap(response)));
} catch (error) {
    Console.log(error.message);
}

Complete code example

import Iot, * as $Iot from '@alicloud/iot20180120';
import Util from '@alicloud/tea-util';
import Env from '@alicloud/darabonba-env';
import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
import Console from '@alicloud/tea-console';
import * as $tea from '@alicloud/tea-typescript';


export default class Client {
  /**
   * Use an AccessKey pair (AccessKey ID and AccessKey secret) to initialize a client.
   * @param accessKeyId
   * @param accessKeySecret
   * @param regionId
   * @return Client
   * @throws Exception
   */
  static createClient(): Iot {
    let config = new $OpenApi.Config({ });
    // Your AccessKey ID.
    config.accessKeyId = process.env.ACCESS_KEY_ID;
    // Your AccessKey secret.
    config.accessKeySecret = process.env.ACCESS_KEY_SECRET;
    // Your region ID.
    config.regionId = "cn-shanghai";
    return new Iot(config);
   }


  static async main(args: string[]): Promise<void> {
    try {
      let client = Client.createClient("${accessKey}", "${accessKeySecret}");
      let request = new $Iot.PubRequest({
        // The ID of the IoT Platform instance.
        iotInstanceId: "${iotInstanceId}",
        // The ProductKey of the product.
        productKey: "${productKey}",
        // The message body to send. This is a Base64-encoded "hello world" string.
        messageContent: "eyJ0ZXN0IjoidGFzayBwdWIgYnJvYWRjYXN0In0=",
        // The custom topic of the device that receives the message.
        topicFullName: "/${productKey}/${deviceName}/user/get",
        // The method to send the message. QoS 0 and QoS 1 are supported.
        qos: 0,
      });
      let response = await client.pub(request);
      Console.log(response.body.success);
      Console.log(response.body.requestId);
    } catch (error) {
      Console.log(error.message);
    }    
  }
}

Client.main(process.argv.slice(2));