Help Center> IoT Device Access> SDK Reference> Old SDKs> Application Java SDK API Reference> Subscription Management> Deleting Subscriptions in Batches
View PDF

Deleting Subscriptions in Batches

Typical Scenario

If an application does not need to receive subscription notifications pushed by the platform or a specified type of subscription notifications, the application can call this API to delete subscription configurations in batches and cancel the subscriptions.

API Function

This API is used to delete all subscriptions, subscriptions of a specified subscription type, or subscriptions of a specified callback URL in batches.

API Description

1
 
void deleteBatchSubscriptions(DeleteBatchSubInDTO dbsInDTO, String accessToken) throws NorthApiException

Parameter Description

Parameter

Mandatory or Optional

Type

Location

Description

dbsInDTO

Mandatory

DeleteBatchSubInDTO

body

For details, see the DeleteBatchSubInDTO structure.

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.

DeleteBatchSubInDTO

Parameter

Mandatory or Optional

Type

Location

Description

appId

Optional

String(256)

query

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

notifyType

Optional

String(256)

query

Indicates the notification type based on which an application can process messages.

  • bindDevice: device bound
  • deviceAdded: device added
  • deviceInfoChanged: device information changed
  • deviceDataChanged: device data changed
  • deviceDatasChanged: batch device data changed
  • deviceCapabilitiesChanged: device service capability changed
  • deviceCapabilitiesAdded: device service capability added
  • deviceCapabilitiesDeleted: device service capability deleted
  • deviceDeleted: device deleted
  • messageConfirm: message confirmed
  • commandRsp: command response
  • deviceDesiredPropertiesModifyStatusChanged: device shadow modification status changed
  • swUpgradeStateChangeNotify: software upgrade status changed
  • swUpgradeResultNotify: software upgrade result
  • fwUpgradeStateChangeNotify: firmware upgrade status changed
  • fwUpgradeResultNotify: firmware upgrade result

callbackUrl

Optional

String(256)

query

Indicates the callback URL of the subscription.

Response Parameters

void

Error Codes

HTTP Status Code

Error Code

Error Description

Remarks

403

100217

The application has not 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

The application calls the API at a frequency that exceeds the flow control threshold.

The application 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

Invalid access token or application ID.

The access token is invalid.

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

404

100225

The resource cannot be found.

The resource does not exist.

Recommended handling: Check whether notifyType is correct.
Parent topic: Subscription Management