Carrier Reverse Notification API - Pay-per-use

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

operationList

Yes

Array of ReverseOperationAllPropertiesInfo objects

Definition:

Operation list.

Constraints:

A maximum of 50 elements are allowed.

Range:

N/A

Default Value:

N/A

batchSN

Yes

String

Definition:

Batch operation SN.

Constraints:

The value can contain a maximum of 64 characters.

Range:

N/A

Default Value:

N/A

packageChangeList

No

Array of PackageChangeInfo objects

Definition:

Package modification operation set.

Constraints:

Only one element is allowed.

Range:

N/A

Default Value:

N/A

operationSN

Yes

String

Definition:

Operation SN.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

carrierUserId

Yes

String

Definition:

Carrier user ID.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

changeType

Yes

Integer

Definition:

Change type.

Constraints:

N/A

Range:

1: subscription

Default Value:

N/A

packageId

Yes

String

Definition:

Carrier package ID, which is unique.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

packageType

Yes

Integer

Definition:

Package type.

Constraints:

This parameter is mandatory when packageId is specified.

Range:

-2: consecutive monthly basic package

-3: consecutive yearly basic package

-4: expansion package based on the basic package

-5: independent expansion package

Default Value:

N/A

capacity

Yes

Integer

Definition:

Package capacity.

Constraints:

This parameter is mandatory when packageId is specified.

Range:

The unit is KB.

Default Value:

N/A

activateTime

No

String

Definition:

Activation time, in ISO standard time format.

Constraints:

This parameter is mandatory when changeType is set to 1 and must be within the current billing cycle. This parameter is optional when changeType is set to 0.

Range:

N/A

Default Value:

N/A

packageName

No

String

Definition:

Package name.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

status

Yes

String

Definition:

Package status.

Constraints:

N/A

Range:

0: offline 1: released

Default Value:

N/A

price

No

String

Definition:

Package price.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

promotionPrice

No

String

Definition:

Package discount price.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

countryCode

No

String

Definition:

Country/Region code. See ISO 3166-1 alpha-3.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

currencyCode

No

String

Definition:

Currency code. See ISO 4217.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

count

No

Integer

Definition:

Subscription quantity.

Constraints:

N/A

Range:

N/A

Default Value:

1

channel

No

String

Definition:

Channel field.

Constraints:

N/A

Range:

The value must start with 00, 01, 02, or 03 and be followed by any six characters (eight characters in total).

Default Value:

N/A

unlimit

No

Integer

Definition:

Unlimited package.

Constraints:

N/A

Range:

0: limited 1: unlimited

Default Value:

N/A

properties

No

Object

Definition:

Extended field.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

basePackageId

No

String

Definition:

Basic package ID.

Constraints:

This field is mandatory only when packageType is set to 4 or 5.

Range:

N/A

Default Value:

N/A

code

String

Status code.

msg

String

Status description.

data

Array of BatchOperationInfo objects

Reverse notification response data.

batchSN

String

Batch operation SN.

operationList

Array of OperationResultInfo objects

Batch operation data (The current list can contain up to 50 elements, which is configurable).

operationSN

String

Operation SN.

carrierUserId

String

Carrier user ID.

kdUserId

String

KooDrive internal user ID.

packageChangeList

Array of PackageChangeInfo objects

Package modification operation set. Only one element is supported.

status

Integer

Operation result.

-0: The operation is in progress.

-1: successful

-2: failed

errorCode

String

Error code, which is returned when the operation fails.

errorMsg

String

Error information, which is returned when the operation fails.

changeType

Integer

Definition:

Change type.

Constraints:

N/A

Range:

1: subscription

Default Value:

N/A

packageId

String

Definition:

Carrier package ID, which is unique.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

packageType

Integer

Definition:

Package type.

Constraints:

This parameter is mandatory when packageId is specified.

Range:

-2: consecutive monthly basic package

-3: consecutive yearly basic package

-4: expansion package based on the basic package

-5: independent expansion package

Default Value:

N/A

capacity

Integer

Definition:

Package capacity.

Constraints:

This parameter is mandatory when packageId is specified.

Range:

The unit is KB.

Default Value:

N/A

activateTime

String

Definition:

Activation time, in ISO standard time format.

Constraints:

This parameter is mandatory when changeType is set to 1 and must be within the current billing cycle. This parameter is optional when changeType is set to 0.

Range:

N/A

Default Value:

N/A

packageName

String

Definition:

Package name.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

status

String

Definition:

Package status.

Constraints:

N/A

Range:

0: offline 1: released

Default Value:

N/A

price

String

Definition:

Package price.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

promotionPrice

String

Definition:

Package discount price.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

countryCode

String

Definition:

Country/Region code. See ISO 3166-1 alpha-3.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

currencyCode

String

Definition:

Currency code. See ISO 4217.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

count

Integer

Definition:

Subscription quantity.

Constraints:

N/A

Range:

N/A

Default Value:

1

channel

String

Definition:

Channel field.

Constraints:

N/A

Range:

The value must start with 00, 01, 02, or 03 and be followed by any six characters (eight characters in total).

Default Value:

N/A

unlimit

Integer

Definition:

Unlimited package.

Constraints:

N/A

Range:

0: limited 1: unlimited

Default Value:

N/A

properties

Object

Definition:

Extended field.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

basePackageId

String

Definition:

Basic package ID.

Constraints:

This field is mandatory only when packageType is set to 4 or 5.

Range:

N/A

Default Value:

N/A

200

Carrier reverse notification response body.