Search Custom Phone Templates

Searches custom phone templates with pagination. The results contain the basic, advanced, and custom template types.

Request URL

POST {base_url}/uc-cautop/api/v1/phone-templates/custom/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	Yes	Integer	The number of records per page.
pageNumber	Yes	Integer	The page number to query, starting from 1.
vendor	No	Array<String>	The list of vendor identifiers used to filter the templates.
keyword	No	String	The keyword used for fuzzy matching of the template name, template type, source default template, description, assigned reseller email, and assigned tenant code.
sorts	No	Array<Sort_Condition>	The sort conditions.

Sort_Condition


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

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<Template_Page>	The search result of custom templates.

Template_Page


Parameter	Type	Description
pageSize	Integer	The number of records per page.
pageNumber	Integer	The current page number.
count	String	The total number of matching records.
results	Array<Template_List_Item>	The list of templates that match the search conditions.

Template_List_Item


Parameter	Type	Description
id	String	The unique ID of the template.
name	String	The name of the template.
templateType	String	The type of the template.
vendor	String	The identifier of the phone vendor.
supportedModels	Array<String>	The list of phone models supported by the template.
phoneType	String	The type of the device.
description	String	The description of the template.
version	String	The version number of AppCenter.
createdAt	String	The creation time, in Unix timestamp format (seconds).
updatedAt	String	The last update time, in Unix timestamp format (seconds).
ownerType	String	The type of the owner.
baseTemplateId	String	The ID of the base template.
permission	Object<Template_Permission>	The permissions of the current user on the template.
ownerEmail	String	The email address of the owner primary account.
baseTemplateName	String	The name of the base template.
assignedResellers	Array<String>	The list of reseller emails that the template is assigned to.
assignedTenants	Array<String>	The list of tenant codes that the template is assigned to.
ownerDisplay	String	The display name of the owner.

Template_Permission


Parameter	Type	Description
canEdit	Boolean	Whether the current user can edit the template.
canDelete	Boolean	Whether the current user can delete the template.
canAssign	Boolean	Whether the current user can assign the template.
canUpdateToDevice	Boolean	Whether the current user can push the template updates to devices.

Example

Request example

POST /uc-cautop/api/v1/phone-templates/custom/search-page HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJhcHBfa2V5Ijoic2xOdnQzaHc1NXB2Vm5HRlNhR2ZOVTNmMWxYQ3lpa08iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MjU2NjA5OSwiaWF0IjoxNzkyNTQ0NDk5LCJqdGkiOiI3NjY2ZWU3Ny0zZTYwLTQxMGEtOTQyMy1hOTRlZmNlZjYwMjYiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.zQ5trUGZLZpONqSK-W4IYwft0hfjEAEQ1Yltse27gR0Wfec--msHIKXs3Ukvc9kKdU04IplkNgtjj_iHr31STcCdu_XAfU3E3A2AiNzkcd1f6jwIqs3_ZVOkQLLgwUkpRY_6vWkhOmwlyU8L4ue2n03eoYRU__IdHlECXTSh9P-QmPUWF2Sxti8zctDpA6QqeoSnIO5ChKHC8n8IG9k82HKfigG5SrFkD9MR6EOUjw3feqFH9mVJvuL61ZPYBhJ29hHo7hsgxDahs9s3p-A02J3zEQrsHDCFM4KtB-9wm8e1j26rl_cfC14BIxo0BeZLSAuAEVnEXwpVdSBEXOu9PA
Content-Type: application/json
{
  "pageNumber": 1,
  "pageSize": 5
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "0b5485d1c0775b1608874f5aad85deaa",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "pageSize": 5,
    "pageNumber": 1,
    "count": 0,
    "results": []
  }
}