All Products
Search
Document Center

BSS OpenAPI:GetCustomerList

Last Updated:Mar 01, 2024

Queries the IDs of customers of a virtual network operator (VNO).

Operation description

The system queries the IDs of customers of a VNO based on the AccessKey pair used in the request.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
The current API does not require request parameters

Response parameters

ParameterTypeDescriptionExample
object

The object returned.

Codestring

The status code returned.

200
Messagestring

The message returned.

Successful!
RequestIdstring

The ID of the request. You can use the ID to query logs and troubleshoot issues.

79EE7556-0CFD-44EB-9CD6-B3B526E3A85F
Successboolean

Indicates whether the call is successful. Valid values:

  • true: The call is successful.
  • false: The call failed.
true
Dataobject

The data returned.

UidListarray

The list of customer IDs.

string

The ID of the customer.

6210322125051645960

Examples

Sample success responses

JSONformat

{
  "Code": "200",
  "Message": "Successful!",
  "RequestId": "79EE7556-0CFD-44EB-9CD6-B3B526E3A85F",
  "Success": true,
  "Data": {
    "UidList": [
      "6210322125051645960"
    ]
  }
}

Error codes

HTTP status codeError codeError message
400NotAuthorizedThis API is not authorized for caller.
401VnoNoDataErrorThere is no data by this request.
402NotFoundRamActionNot found ramAction for apiActon: GetCustomerList
500InternalErrorThe request processing has failed due to some unknown error.

For a list of error codes, visit the Service error codes.