Help Center/ KooDrive/ API Reference（Carrier）/ API/ User registration and provisioning/ Querying Batch Provisioning
Updated on 2026-04-16 GMT+08:00
View PDF
Share

Querying Batch Provisioning

Function

Query batch provisioning.

URI

GET /koodrive/ose/v1/user/batchRegister/get

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

taskId

Yes

String

Task ID.

cursor

No

String

Current page cursor, which is obtained from nextCursor of the previous response.

pageSize

No

Integer

Number of records on each page.

Range:

[1, 1000]

Default Value:

1000.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Authorization

Yes

String

Definition:

Signature generated in AK/SK authentication mode.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

X-Date

Yes

String

Definition:

Date, which is used for app authentication. The format is yyyyMMdd'T'HHmmss'Z'.

Constraints:

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

Range:

N/A

Default Value:

N/A

X-User-Id

Yes

String

Definition:

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

Constraints:

N/A

Value 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

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

code

String

Error Codes

msg

String

Error description.

data

data object

Response for user provisioning.
Table 4 data

Parameter

Type

Description

nextPageCursor

String

Next page cursor value.

registerList

Array of registerList objects

List of registered users.

taskInfo

taskInfo object

Task information.
Table 5 registerList

Parameter

Type

Description

id

String

Subtask ID.

userId

String

User ID after successful registration.

phone

String

User mobile number.

code

String

Error code, which is mandatory when the registration fails.

reason

String

Error cause, which is mandatory when the registration fails.
Table 6 taskInfo

Parameter

Type

Description

taskId

String

Task ID.

status

String

Task status.

totalCount

Integer

Total number of tasks.

successCount

Integer

Number of users that are successfully provisioned.

failCount

Integer

Number of users that fail to be provisioned.

skipCount

Integer

Number of users that are skipped.

Example Requests

GET /koodrive/ose/v1/user/batchRegister/get?taskId=1882735962480556672&cursor=0&pageSize=1

Example Responses

Status code: 200

Response to the request for querying batch provisioning.

{
  "data" : {
    "taskInfo" : {
      "taskId" : "1895065728646757504",
      "status" : "2",
      "totalCount" : 2,
      "successCount" : 1,
      "failCount" : 0,
      "skipCount" : 1
    },
    "registerList" : [ {
      "id" : "1895065728646757504",
      "userId" : "1895065729401744000",
      "phone" : "12345557"
    }, {
      "id" : "1895065728646757504",
      "userId" : "1844090530019957504",
      "phone" : "12345557",
      "code" : "40000009",
      "reason" : "The user already exists."
    } ],
    "code" : 0,
    "msg" : "success"
  },
  "code" : 0,
  "msg" : "Success"
}

Status Codes

Status Code

Description

200

Response to the request for querying batch provisioning.