Search Resellers

Searches reseller accounts with pagination and returns the list of resellers that match the search conditions.

Request URL

POST {base_url}/uc-user/api/v1/accounts/resellers/search-page

Request parameters

Headers


Parameter	Required	Type	Description
Authorization	Yes	String	The access token used for authentication. Format: Bearer `{access_token}`.
x-tenant-code	No	String	The tenant name. Note: You can obtain tenant name using the Query Tenants interface.

Body parameters


Parameter	Required	Type	Description
pageSize	No	Integer	The number of records to retrieve per page.
pageNumber	No	Integer	The page number to retrieve.
sorts	No	Array<Sort_Condition>	The sort conditions.
keyword	No	String	The keyword used for fuzzy matching, which matches the first name, last name, and email address of accounts.
subType	No	String	The sub type of the user, used to filter accounts. Valid value: `ADMIN` `RESELLER`
status	No	String	The status of the account, used to filter accounts.
name	No	String	The name of the user, used for fuzzy matching.
email	No	String	The email address, used for fuzzy matching.
company	No	String	The company name, used for fuzzy matching.
owner	No	String	The email of the owner account, used for fuzzy matching.
createTimeStart	No	Integer	The start of the creation time, in Unix timestamp format (milliseconds).
createTimeEnd	No	Integer	The end of the creation time, in Unix timestamp format (milliseconds).
idList	No	Array<Integer>	The list of account IDs, which is passed in when exporting selected records and is ignored when empty.
trunkIds	No	Array<Integer>	The list of trunk IDs. When this parameter is not empty, only the resellers that own the specified trunks are returned.
trunkIdScoped	No	Boolean	Reserved for internal use. Do not pass this parameter from the client side.

Sort_Condition


Parameter	Required	Type	Description
property	No	String	The name of the field to sort by.
direction	No	String	The sort order. Valid value: `asc`: Sort in ascending order. `desc`: Sort in descending order.

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<Reseller_Page_Result>	The search result of resellers.

Reseller_Page_Result


Parameter	Type	Description
pageSize	Integer	The number of records per page.
pageNumber	Integer	The current page number.
total	Integer	The total number of records that match the search conditions.
results	Array<Reseller_Page_Response>	The list of resellers that match the search conditions.
totalPages	Integer	The total number of pages.
empty	Boolean	Whether the current page is empty.

Reseller_Page_Response


Parameter	Type	Description
id	String	The ID of the account.
ucId	String	The UC ID of the company that the account belongs to.
subType	String	The sub type of the user: `ADMIN`: The administrator. `RESELLER`: The reseller. This parameter is visible only to the super administrator.
firstName	String	The first name of the user.
lastName	String	The last name of the user.
status	String	The status of the account.
email	String	The email address of the account, which is used as the login username.
company	String	The company name.
phone	String	The phone number.
address	String	The address.
profileImage	String	The URL of the avatar (a permanent public link of the resource). This parameter is null when no avatar is set.
owner	String	The email of the owner account. This parameter is visible only to the super administrator.
twoFactorEnabled	Boolean	Whether two-factor authentication is enabled.
remark	String	The remark of the account.
createTime	Integer	The time when the account was created, in Unix timestamp format (milliseconds).
hasMatchingColleagues	Boolean	Whether any colleague account matches the search conditions. This parameter prompts the front end to expand and display the colleague list.
colleaguesCount	Integer	The number of colleague accounts of the primary account. The value 0 indicates that the primary account has no colleague account.
tenants	Object<Quota_Field>	The tenant quota.
users	Object<Quota_Field>	The user quota.
concurrentCalls	Object<Quota_Field>	The concurrent call quota.
recordingUsers	Object<Recording_Users_Quota_Field>	The recording user quota.
brandingTemplates	Object<Quota_Field>	The branding template quota.
awsTranscriptionUsers	Object<Quota_Field>	The transcription user quota.
receptionistMinutes	Object<Quota_Field>	The AI receptionist minutes quota.
receptionistPacks	Object<Receptionist_Pack_Quota_Field>	The AI receptionist pack quota.

Quota_Field


Parameter	Type	Description
used	Integer	The used amount.
total	Integer	The quota limit. The value -1 indicates unlimited.

Recording_Users_Quota_Field


Parameter	Type	Description
used	Integer	The used amount.
total	Integer	The quota limit. The value -1 indicates unlimited.
details	Array<Retention_Detail>	The list of recording user quotas grouped by retention period.

Retention_Detail


Parameter	Type	Description
packageValue	Integer	The value of the retention period, such as 3.
packageUnit	String	The unit of the retention period, such as month or year. This parameter is returned only when the recording user quota is configured.
used	Integer	The used amount.
total	Integer	The quota limit of this retention period.

Receptionist_Pack_Quota_Field


Parameter	Type	Description
used	Integer	The used amount.
total	Integer	The quota limit. The value -1 indicates unlimited.
details	Array<Pack_Detail_Field>	The list of AI receptionist pack quotas grouped by pack capacity.

Pack_Detail_Field


Parameter	Type	Description
packageValue	Integer	The capacity of the pack in minutes, such as 1000.
packageUnit	String	The unit of the pack capacity, such as min.
used	Integer	The number of packs in use.
total	Integer	The total number of packs of this capacity.

Example

Request example

POST /uc-user/api/v1/accounts/resellers/search-page HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJtdDEwMDBAbWFpbHN0YXIudG9wIiwiYXBwX2tleSI6Im9icWJUSWd1ZkJ5d3ZCNmF0VURmVDZpeDJvUlhUb0wzIiwiZ3JhbnRfdHlwZSI6Im9wZW5hcGkiLCJjbGllbnRfZXh0Ijp7ImRlc2NyaXB0aW9uIjoi56ys5LiJ5pa55ZCI5L2c5LyZ5Ly05bqU55SoIiwicGFydG5lciI6IuekuuS-i-WQiOS9nOS8meS8tCJ9LCJjbGllbnRfdHlwZSI6Im9wZW5hcGkiLCJleHAiOjE3OTIwNzI3NTcsImlhdCI6MTc5MjA1MTE1NywianRpIjoiOTVkOGM1YWMtNzg3MS00ZjlmLWFiOWUtYzFjOTBlYzU4N2M1IiwiY2xpZW50X2lkIjoibm92by1vcGVuLXBsYXRmb3JtIiwidXNlcl9leHQiOnsicm9sZUlkcyI6WzNdLCJzdHlwZSI6IkFETUlOIiwidGVuYW50Q29kZSI6bnVsbCwidHlwZSI6IlBfQUNDT1VOVCIsInVzZXJJZCI6MjA4NTMxNTk0ODg0OTgyNzg0MiwiZW1haWwiOiJtdDEwMDBAbWFpbHN0YXIudG9wIiwidXNlcm5hbWUiOiJtdDEwMDBAbWFpbHN0YXIudG9wIiwidWNJZCI6MjA4NTMxNTk0ODI4Nzc5MTEwNn19.AmC_hWm0Pa51VbO2YaQZF3gXofw5NQDi_njH-fPAi2r_kWc8PyxkK6vq212lTPHR-eDMY3CaXhUxptGNcUUXAHfbuFqHXBcLvZ1ggmMCYLlSpcsj9TBg3BULyvHOlJBEbO7b_OOBZi_fGG-Oe3e9m-EsdOjA150ZJKU9trq-QUqFndTvdMZV9JHDV2xpDwgKdT6v4xNhM9TaAT9_tLmOtSipIijx32ng8CIDd0l7jWYfrmwsjf32n0P232nXmKfdADjSuKAp8TNxc17ccFxt9k0aQlB9uyhGPjIdCHSK7hill2VbzVAGuVzj3b1AplQz2cAVmVhXqWqOfpfjM1tY9A
Content-Type: application/json
{
  "pageNumber": 1,
  "pageSize": 5,
  "email": "aitdoc-r51280@mailstar.top"
}

Response example

HTTP/1.1 200 OK
{
  "result": {
    "pageSize": 5,
    "pageNumber": 1,
    "total": 1,
    "results": [
      {
        "id": "2110642174721605633",
        "ucId": "2110642175052955650",
        "firstName": "Doc",
        "lastName": "Reseller",
        "status": "INACTIVE",
        "email": "aitdoc-r51280@mailstar.top",
        "company": "AIT Doc Test Inc",
        "phone": "13900139001",
        "address": "Test Ave 2",
        "profileImage": "https://tst-client-hosted-0-business-992382618242-ap-east-1-an.s3.ap-east-1.amazonaws.com/public/platform/_GLOBAL/user_avatar/1792051622734/aitdoc-avatar2.png",
        "twoFactorEnabled": false,
        "remark": "ait-doc-updated",
        "createTime": 1792051283027,
        "hasMatchingColleagues": false,
        "colleaguesCount": 0,
        "tenants": {
          "used": 0,
          "total": 8
        },
        "users": {
          "used": 0,
          "total": 10
        },
        "concurrentCalls": {
          "used": 0,
          "total": 20
        },
        "recordingUsers": {
          "used": 0,
          "total": 5,
          "details": [
            {
              "packageValue": 1,
              "packageUnit": "month",
              "used": 0,
              "total": 5
            }
          ]
        },
        "brandingTemplates": {
          "used": 0,
          "total": 1
        },
        "awsTranscriptionUsers": {
          "used": 0,
          "total": 4
        }
      }
    ],
    "totalPages": 1,
    "empty": false
  },
  "requestId": "4df5a45751cdc8f8323631a2fa6581aa",
  "code": "200",
  "message": "SUCCESS"
}