Updated on 2022-02-24 GMT+08:00

Deleting a Subscription

Typical Scenario

If an NA does not need to receive a subscription notification message pushed by the IoT platform, the NA can call this API to delete the specified subscription configuration and cancel the subscription.

API Function

This API is used by an NA to delete the configuration information about a subscription by subscription ID on the IoT platform.

API Description

1
void deleteSingleSubscription(String subscriptionId, String appId, String accessToken) throws NorthApiException

Parameter Description

Parameter

Mandatory or Optional

Type

Location

Description

subscriptionId

Mandatory

String(256)

path

Identifies a subscription.

appId

Optional

String(256)

query

Identifies the application of the entity that subscribes to a device or rule.

accessToken

Mandatory

String

header

If the Periodically Refreshing a Token API is called, set this parameter to null. Otherwise, set this parameter to the accessToken obtained by the Authentication API.

Response Parameters

void

Error Codes

HTTP Status Code

Error Code

Error Description

Remarks

403

100217

The application hasn't been authorized.

The application has not been authorized.

Recommended handling: In scenarios where applications are not authorized, ensure that request parameter appId is null.

403

1010009

app throttle exceed.

The NA calls the API at a frequency that exceeds the flow control threshold (100 calls per minute by default).

Recommended handling: Contact IoT platform maintenance personnel to adjust the flow control threshold or control the API call frequency.

403

1010005

App_key or access_token is invalid.

The access token is invalid.

Recommended handling: Check whether accessToken carried in the API request is correct.

404

100225

The resource is not found

The resource does not exist.

Recommended handling: Check whether subscriptionId is correct.