Help Center/KooDrive/API Reference(Carrier)/API/Benefit Distribution/Notifying a User That a Package Expires and Enters the Reservation Period
Updated on 2026-02-12 GMT+08:00

Notifying a User That a Package Expires and Enters the Reservation Period

Function

Notify a user that the package expires and enters the reservation period. This function can be called only after the whitelist is added.

URI

POST /koodrive/ose/v1/carrier/users/notifyPackageExpire

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

Authorization

Yes

String

Definition:

This field stores the access token.

Token authentication is used to call KooDrive APIs. A token indicates the permission. When an API is called, the token is added to the request header to obtain the operation permission.

Constraints:

The format is bearer+access token.

Range:

For details about how to obtain an access token, see the corresponding developer guide.

Default Value:

N/A

X-Date

Yes

String

Definition:

Signature time, which is used for app ID authentication.

Constraints:

The time must be within 15 minutes from the current time and cannot be later than the current time.

Range:

The format is yyyMMdd'T'HHmmss'Z', for example, 20251103T070140Z.

Default Value:

N/A

X-User-Id

Yes

String

Definition:

User ID on KooDrive, which is used for app ID authentication.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

x-traceid

No

String

Definition:

Service trace ID, which contains 58 bits.

Constraints:

N/A

Range:

The value contains 58 bits.

Default Value:

N/A

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

carrierUserId

Yes

String

Definition:

Carrier user ID.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

type

Yes

Integer

Definition:

Modification type.

Constraints:

N/A

Range:

2- Enter the reservation period.

Default Value:

N/A

packageId

Yes

String

Definition:

Carrier package ID, which is unique.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

code

String

Status code.

msg

String

Status description.

Example Requests

/koodrive/ose/v1/carrier/users/notifyPackageExpire

{
  "carrierUserId" : "189642158555241211",
  "type" : 1,
  "packageId" : "14"
}

Example Responses

Status code: 200

Response body for notifying a user that a package expires and enters the reservation period.

{
  "code" : 0,
  "msg" : "Success."
}

Status Codes

Status Code

Description

200

Response body for notifying a user that a package expires and enters the reservation period.