Get Bindable Extensions

Gets the list of extensions that can be bound to phones.

Request URL

GET {base_url}/uc-cautop/api/v1/tenant/phones/extension-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
tenantCode Yes String The tenant code.

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<Extensions_Result> The list of bindable extensions.
Extensions_Result
Parameter Type Description
options Array<Extension_Option> The list of bindable extensions.
Extension_Option
Parameter Type Description
userId String The ID of the user.
extension String The extension number.
name String The display name of the user.
firstName String The first name of the user.
lastName String The last name of the user.
status String The status of the extension.
assignedCount Integer The number of phones assigned to the extension.
concurrentRegistrations Integer The number of concurrent registrations supported by the extension.

Example

Request example

GET /uc-cautop/api/v1/tenant/phones/extension-options?tenantCode=jint 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": "b068e1ede5994bf5f0447eb4763e2ef6",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "options": [
      {
        "userId": "338136731335409664",
        "extension": "1000",
        "name": "Leo Ball",
        "concurrentRegistrations": 2,
        "assignedCount": 0,
        "status": "unassigned",
        "firstName": "Leo",
        "lastName": "Ball"
      },
      {
        "userId": "342552093490561024",
        "extension": "1001",
        "name": "Terrell Smith",
        "concurrentRegistrations": 1,
        "assignedCount": 0,
        "status": "unassigned",
        "firstName": "Terrell Smith",
        "lastName": ""
      },
      {
        "userId": "338855950145581056",
        "extension": "1002",
        "name": "Philip Huff",
        "concurrentRegistrations": 1,
        "assignedCount": 0,
        "status": "unassigned",
        "firstName": "Philip Huff",
        "lastName": ""
      },
      {
        "userId": "345441128009715712",
        "extension": "1003",
        "name": "Troy Daniel",
        "concurrentRegistrations": 1,
        "assignedCount": 0,
        "status": "unassigned",
        "firstName": "Troy Daniel",
        "lastName": ""
      },
      {
        "userId": "345860923599089664",
        "extension": "1004",
        "name": "Example Lee",
        "concurrentRegistrations": 1,
        "assignedCount": 0,
        "status": "unassigned",
        "firstName": "Example",
        "lastName": "Lee"
      },
      {
        "userId": "355531919887114240",
        "extension": "1005",
        "name": "w x",
        "concurrentRegistrations": 1,
        "assignedCount": 0,
        "status": "unassigned",
        "firstName": "w",
        "lastName": "x"
      }
    ]
  }
}