Get Phone Template Options

Request URL

GET {base_url}/uc-cautop/api/v1/tenant/phones/template-options

Request parameters

Headers


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

Query parameters


Parameter	Required	Type	Description
vendor	No	String	The vendor identifier used to filter the templates. If this parameter is not specified, templates of all vendors are returned.
model	No	String	The model identifier used to filter the templates with an exact match.
templateTypes	No	Array<String>	The template types used to filter the templates. If this parameter is not specified, templates of all types are returned. Valid value: `default` `basic` `advanced` `custom`

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<Templates_Result>	The list of template options.

Templates_Result


Parameter	Type	Description
options	Array<Template_Option>	The list of templates.

Template_Option


Parameter	Type	Description
id	String	The ID of the template.
name	String	The name of the template.
phoneType	String	The type of the phone that the template applies to.
templateType	String	The type of the template.
rpsSupported	Boolean	Whether the RPS provisioning is supported for the template.

Example

Request example

GET /uc-cautop/api/v1/tenant/phones/template-options?vendor=Yealink&model=T31P&templateTypes= HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJhcHBfa2V5Ijoic2xOdnQzaHc1NXB2Vm5HRlNhR2ZOVTNmMWxYQ3lpa08iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MjU2NDE0MCwiaWF0IjoxNzkyNTQyNTQwLCJqdGkiOiJlYTFhNTY3NS1hNWFhLTQ0ZjYtOWJlYy02YmQzZmY1NmU0YTIiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.roCif8Pv80MWNHH0IQgaDxQS4hx-V-zbU1Zid56qqlAEoSV5Xisv-Rh1tPnWiDqxHUJoMXE8FFDgK_JS2wGBJF6Qz5VD8HMSQFeiHgHlqrKHbOUlf4SiCz8Qww0xX2gsCq0JPS3snT5MrvRIHyyFtMVTNMCe9HgAv_yT1KntyE6GuHA8OTTWTUvfRRkOdX9PgdcRpl3w0sOrPel_HBjUmYAzQm6hYMP-Aj9ygjFCVuqc91Al_6Oc5nuJsue923LbFBzp-2kKKPXGGJIm66xDLBOOgg6NbRcUv30uJuiaYMjJPUX90jNeXLoKuvEVmMdiYKEB02Si3sjtoX6pUHLcLQ
x-tenant-code: jint

Response example

HTTP/1.1 200 OK
{
  "requestId": "59c5721685aaffbfaa0a27e8b14cdd8b",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "options": [
      {
        "id": "363237944809508864",
        "name": "ee",
        "templateType": "basic",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428389000138752",
        "name": "YSDP_FanvilH2U",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428389092413440",
        "name": "YSDP_FanvilH4W",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428389226631168",
        "name": "YSDP_FanvilH5",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428389935468544",
        "name": "YSDP_Fanvili10S",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428389977411584",
        "name": "YSDP_Fanvili10SV",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428389969022976",
        "name": "YSDP_Fanvili20S",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428390199709697",
        "name": "YSDP_Fanvili53W",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428390145183744",
        "name": "YSDP_Fanvili56A",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428390199709696",
        "name": "YSDP_Fanvili68",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428389184688128",
        "name": "YSDP_FanvilV6",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "335776760495071232",
        "name": "YSDP_FanvilW710D",
        "templateType": "default",
        "phoneType": "dect",
        "rpsSupported": true
      },
      {
        "id": "315428389331488768",
        "name": "YSDP_FanvilX301G",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428389386014720",
        "name": "YSDP_FanvilX303-2WIRE",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428389482483712",
        "name": "YSDP_FanvilX3SW",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428389478289408",
        "name": "YSDP_FanvilX3U",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428389524426752",
        "name": "YSDP_FanvilX4",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428389679616000",
        "name": "YSDP_FanvilX4U",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428389801250816",
        "name": "YSDP_FanvilX5S",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428389734141952",
        "name": "YSDP_FanvilX6",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428393861337088",
        "name": "YSDP_PolyEdgeE",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428393991360512",
        "name": "YSDP_PolyVVX",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428394041692160",
        "name": "YSDP_SnomD",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428394180104192",
        "name": "YSDP_SnomDECT",
        "templateType": "default",
        "phoneType": "dect",
        "rpsSupported": true
      },
      {
        "id": "315428394188492800",
        "name": "YSDP_SnomE",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428394247213056",
        "name": "YSDP_SnomHD",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428394398208000",
        "name": "YSDP_SnomM100KLE",
        "templateType": "default",
        "phoneType": "dect",
        "rpsSupported": true
      },
      {
        "id": "315428394373042176",
        "name": "YSDP_SnomM250",
        "templateType": "default",
        "phoneType": "dect",
        "rpsSupported": true
      },
      {
        "id": "315428394440151040",
        "name": "YSDP_SnomM500",
        "templateType": "default",
        "phoneType": "dect",
        "rpsSupported": true
      },
      {
        "id": "315428394545008640",
        "name": "YSDP_SnomOld",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428394528231424",
        "name": "YSDP_SnomPA1P",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428394628894720",
        "name": "YSDP_SnomSP800",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428395056713728",
        "name": "YSDP_YealinkAX",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428395094462464",
        "name": "YSDP_YealinkAX83H",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428395186737152",
        "name": "YSDP_YealinkCP",
        "templateType": "default",
        "phoneType": "conferencephone",
        "rpsSupported": true
      },
      {
        "id": "315428395207708673",
        "name": "YSDP_YealinkCP960",
        "templateType": "default",
        "phoneType": "conferencephone",
        "rpsSupported": true
      },
      {
        "id": "315428395346120704",
        "name": "YSDP_YealinkCP9X5",
        "templateType": "default",
        "phoneType": "conferencephone",
        "rpsSupported": true
      },
      {
        "id": "315428395367092224",
        "name": "YSDP_YealinkT2",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428395392258048",
        "name": "YSDP_YealinkT29",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428395522281472",
        "name": "YSDP_YealinkT2_Old",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428395597778944",
        "name": "YSDP_YealinkT2_Old2",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": false
      },
      {
        "id": "315428395606167552",
        "name": "YSDP_YealinkT3",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428395769745408",
        "name": "YSDP_YealinkT3_Old",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": false
      },
      {
        "id": "315428395799105536",
        "name": "YSDP_YealinkT4",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428395832659968",
        "name": "YSDP_YealinkT40",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428395916546048",
        "name": "YSDP_YealinkT46G",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428395979460608",
        "name": "YSDP_YealinkT46S",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428396000432128",
        "name": "YSDP_YealinkT4xG",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": false
      },
      {
        "id": "315428396084318208",
        "name": "YSDP_YealinkT5",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428396151427072",
        "name": "YSDP_YealinkT56",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428396184981504",
        "name": "YSDP_YealinkT58",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428396256284672",
        "name": "YSDP_YealinkT5xS",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": false
      },
      {
        "id": "315428396403085312",
        "name": "YSDP_YealinkT7",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428396382113792",
        "name": "YSDP_YealinkT8",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428396428251142",
        "name": "YSDP_YealinkT88X",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428396650549248",
        "name": "YSDP_YealinkVP",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "315428396621189120",
        "name": "YSDP_YealinkW60",
        "templateType": "default",
        "phoneType": "dect",
        "rpsSupported": true
      },
      {
        "id": "315428396663132160",
        "name": "YSDP_YealinkW60B",
        "templateType": "default",
        "phoneType": "dect",
        "rpsSupported": true
      },
      {
        "id": "315428396818321408",
        "name": "YSDP_YealinkW70",
        "templateType": "default",
        "phoneType": "dect",
        "rpsSupported": true
      },
      {
        "id": "315428396847681536",
        "name": "YSDP_YealinkW75DM",
        "templateType": "default",
        "phoneType": "dect",
        "rpsSupported": true
      },
      {
        "id": "315428396877041664",
        "name": "YSDP_YealinkW80",
        "templateType": "default",
        "phoneType": "dect",
        "rpsSupported": true
      },
      {
        "id": "315428397015453696",
        "name": "YSDP_YealinkW90DM",
        "templateType": "default",
        "phoneType": "dect",
        "rpsSupported": true
      },
      {
        "id": "336400601256292352",
        "name": "YSDP_YeastarP101P",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "336400601466007552",
        "name": "YSDP_YeastarP103G",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "336400601394704384",
        "name": "YSDP_YeastarP103P",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "336400601440841728",
        "name": "YSDP_YeastarP103W",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      },
      {
        "id": "336400601608613888",
        "name": "YSDP_YeastarP104G",
        "templateType": "default",
        "phoneType": "deskphone",
        "rpsSupported": true
      }
    ]
  }
}