Get Available Phone Vendors

Retrieves the phone vendors that can be used when adding phones.

Request URL

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

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.

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<Vendor_Options> The list of available phone vendors.
Vendor_Options
Parameter Type Description
options Array<Vendor_Option> The list of available phone vendors.
Vendor_Option
Parameter Type Description
vendor String The vendor identifier, for example Yealink.
displayName String The display name of the vendor, for example Alcatel-Lucent Enterprise.
phoneType String

The device type of the phone:

  • deskphone: Desk phone.
  • conferencephone: Conference phone.
  • dect: DECT wireless phone.
rpsSupported Boolean Whether the vendor supports RPS.
templateTypes Array<String>

The types of templates that exist for the vendor:

  • default
  • basic
  • advanced
  • custom

Example

Request example

GET /uc-cautop/api/v1/phones/vendor-options HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MDc2MTIyMCwiaWF0IjoxNzkwNzM5NjIwLCJqdGkiOiJiOWY2YTllMC1iNzI1LTQ0MWItOWM4MS0xNTViN2I2MzQzZTEiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.pLZvlI7wJOdlIe2rosP2RgmFghax1RIr5Bx8hM8hNHAcodWeuhl0y6mbm2Rx6HzEIaAqBv51HhtRgJCWUTt8H3Gx7gbGQ-oL-ay5QO8xKWyx9l-o2N9xqoxFnHEVJ1eODMtyZJdi0irq36D95TcDMFLgotKo9TeAr4WrZCelgLyawvyPw8aNpJqNvnc0giI43O8Ov_PjV8VZkQ3UPhWmQEoaLEc1QRCyV546snUuRZd2Ue_wJdW4jHQ5kxSLKq9RXIt-Y3RBweWh4ZALMfSEbOAcg9qzZkA-a_k1c4r2qmYeN1-RS10E7sBmx2KbrQ0JmtfRwzjIfowkZyaIv-5abg
x-tenant-code: jint

Response example

HTTP/1.1 200 OK
{
  "requestId": "b7366e84a6b93facca33091a05cfbfcd",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "options": [
      {
        "vendor": "Fanvil",
        "displayName": "Fanvil",
        "phoneType": "deskphone",
        "rpsSupported": true,
        "templateTypes": [
          "default",
          "basic"
        ]
      },
      {
        "vendor": "Polycom",
        "displayName": "Poly",
        "phoneType": "deskphone",
        "rpsSupported": true,
        "templateTypes": [
          "default"
        ]
      },
      {
        "vendor": "Snom",
        "displayName": "Snom",
        "phoneType": "deskphone",
        "rpsSupported": true,
        "templateTypes": [
          "default"
        ]
      },
      {
        "vendor": "Yealink",
        "displayName": "Yealink",
        "phoneType": "deskphone",
        "rpsSupported": true,
        "templateTypes": [
          "default"
        ]
      }
    ]
  }
}