Bulk Add Tenant Phones

Adds multiple phones to the current tenant in one request.

Request URL

POST {base_url}/uc-cautop/api/v1/tenant/phones/batch

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.
Body parameters
Parameter Required Type Description
vendor Yes String The identifier of the phone vendor.
model Yes String The model of the phones. The template must support this model.
phones Yes Array<Phone_Item> The list of phones to add.
templateId Yes String The ID of the configuration template applied to all phones. You can obtain the ID using the Get Phone Template Options interface.
firstAuth No Boolean Whether to enable first-time authentication.
hotDesking No Boolean Whether to enable Hot Desking.
emergencyCallerId No String The emergency caller ID.
Phone_Item
Parameter Required Type Description
mac Yes String The MAC address of the phone.
userId No Integer The ID of the user whose extension is bound to the phone.

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<Batch_Result> The batch operation result.
Batch_Result
Parameter Type Description
totalCount Integer The total number of phones in the request.
successCount Integer The number of phones processed successfully.
failedCount Integer The number of phones that fail to be processed.
successIds Array<String> The list of IDs of the phones that are processed successfully.
failedItems Array<Failed_Item> The list of phones that fail to be processed, with failure reasons.
Failed_Item
Parameter Type Description
id String The ID of the phone that fails to be processed.
errorMessage String The description of the failure reason.

Example

Request example

POST /uc-cautop/api/v1/tenant/phones/batch 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
Content-Type: application/json
{
  "vendor": "Fanvil",
  "model": "H6W",
  "templateId": "363237944809508864",
  "phones": [
    {
      "mac": "AA:6A:D8:07:E9:CC"
    }
  ]
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "087658f2b19b1b762f58e9880f860da9",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "totalCount": 1,
    "successCount": 1,
    "failedCount": 0,
    "successIds": [
      "371093131491667968"
    ],
    "failedItems": []
  }
}