Unsubscribe BLF

Cancels the BLF subscription of a device.

Request URL

POST {base_url}/uc-cconfig/api/v1/blf/unsubscribe

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.
x-tenant-code Yes String The tenant name.
Note: You can obtain tenant name using the Query Tenants interface.
Body parameters
Parameter Required Type Description
deviceId No String The ID of the device whose BLF subscription is cancelled.
clientType No String

The type of the client.

Valid value:

  • CLIENT_TYPE_MOBILE
  • CLIENT_TYPE_DESKTOP
  • CLIENT_TYPE_WEB

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
result Object<Unsubscribe_Result> The cancellation result.
Unsubscribe_Result
Parameter Type Description
removed Integer The number of BLF subscriptions that are removed.

Example

Request example

POST /uc-cconfig/api/v1/blf/unsubscribe HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiIxMDAwQGNvbG9ydGVzdDIiLCJncmFudF90eXBlIjoicGFzc3dvcmQiLCJ1c2VyX25hbWUiOiIxMDAwQGNvbG9ydGVzdDIiLCJzY29wZSI6WyJyZWFkIiwid3JpdGUiXSwiY2xpZW50X2V4dCI6eyJkZXNjcmlwdGlvbiI6IueuoeeQhuWQjuWPsFdlYuW6lOeUqCIsInBsYXRmb3JtIjoid2ViIn0sImV4cCI6MTc5MzYyMjY0NCwiaWF0IjoxNzkzNjAxMDQ0LCJqdGkiOiIyMzU2N2JhMC02MDFmLTQxNDMtYTFjNy1iOWM2MzUwZjgyMmIiLCJjbGllbnRfaWQiOiJub3ZvLWFkbWluLXdlYiIsInNpZCI6ImM4Mjg2MjNhLTVkZGYtNGExYS1iOWQ4LWJmNzY5YmMzYmQyZiIsInVzZXJfZXh0Ijp7InJvbGVJZHMiOlsxMDJdLCJwdWlkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJ0ZW5hbnRJZCI6MjA3OTUwNDIwNTMwOTE5NDI0MSwicGFyZW50VWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5NiwidGVuYW50Q29kZSI6ImNvbG9ydGVzdDIiLCJ0eXBlIjoiVF9VU0VSIiwidXNlcklkIjoyMDc5NzQ2OTE1Mzg4MDc2MDMzLCJlbWFpbCI6Imxlb0BzYW1wbGUuY29tIiwidXNlcm5hbWUiOiIxMDAwQGNvbG9ydGVzdDIiLCJ1Y0lkIjozMDc2OTEzNjQ0ODkwODMyODk2fX0.yjIo4A2kQM7UM_y8eHTgjqDmSnJwwPnRZskKLRBM9WXO8e35wlCgiEl92qdKEVF-T5iHDAi9wgoEAfZgvTT8sAb4VmdMjV3e-V--VxGpKpzTzcrxrA_GMQaHq-VjCskLINTP-DTVOHdMB3o46Sk3Rg8S2qv2zEI1W58WWHJaTuJu27msNcJEiixhXvvq6eqE2nw_ZZzWsCMlRItTu053nLTLrFfPOPKvS7CUXGNi9bkfqC5autEZQz1jG81wli4CKS7AbMS0f5gumsh6Lbat2RZgu6wj3fywkONhvfk-lRD4V21Jqi_VGbEXxMbanRG1TrmrEok7woZ037Lyf4MBNQ
x-tenant-code: jint
Content-Type: application/json
{
  "deviceId": "doc-test-device",
  "clientType": "CLIENT_TYPE_MOBILE"
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "dc2497650909f2ad96d96279258c33c5",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "removed": 1
  }
}