Help Center > > API Reference> Northbound Java SDK API Reference> Service API List> Subscription Management> Deleting Subscriptions in Batches

Deleting Subscriptions in Batches

Updated at: Aug 28, 2019 GMT+08:00

Typical Scenario

If an NA does not need to receive subscription notification messages pushed by the IoT platform or a specified type of subscription notification messages, the NA 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 NA can process messages.

  • bindDevice: device binding
  • deviceAdded: device addition
  • deviceInfoChanged: device information change
  • deviceDataChanged: device data change
  • deviceDatasChanged: batch device data change
  • deviceDeleted: device deletion
  • messageConfirm: message confirmation
  • commandRsp: command response
  • deviceEvent: device event
  • serviceInfoChanged: service information change
  • deviceModelAdded: device model addition
  • deviceModelDeleted: device model deletion
  • deviceDesiredPropertiesModifyStatusChanged: device shadow modification status change
  • swUpgradeStateChangeNotify: software upgrade status change notification
  • swUpgradeResultNotify: software upgrade result notification
  • fwUpgradeStateChangeNotify: firmware upgrade status change notification
  • fwUpgradeResultNotify: firmware upgrade result notification

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 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 notifyType is correct.

Did you find this page helpful?

Submit successfully!

Thank you for your feedback. Your feedback helps make our documentation better.

Failed to submit the feedback. Please try again later.

Which of the following issues have you encountered?







Please complete at least one feedback item.

Content most length 200 character

Content is empty.

OK Cancel