Bulk Add Phones

Adds multiple phones in one request. The phones share the same vendor, model, and configuration template, and each phone is identified by its own MAC address.

Request URL

POST {base_url}/uc-cautop/api/v1/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 vendor identifier shared by all the phones, for example Yealink, Fanvil, Grandstream.
model Yes String The model shared by all the phones, for example T54W, X5U.
templateId Yes String The ID of the configuration template shared by all the phones. You can obtain the ID using the Get Available Phone Templates interface.
phones Yes Array<Batch_Phone> The list of phones to add, supporting 1 to 100 phones. Each phone specifies its own MAC address and an optional extension binding.
firstAuth No Boolean Whether to enable first-time authentication for all the phones.
hotDesking No Boolean Whether to enable Hot Desking for all the phones.
emergencyCallerId No String The emergency caller number shared by all the phones.
resellerId No String The ID of the reseller that all the phones are assigned to.
tenantCode No String The code of the tenant that all the phones are assigned to.
Batch_Phone
Parameter Required Type Description
mac Yes String The MAC address of the phone, in the format AA:BB:CC:DD:EE:FF or AA-BB-CC-DD-EE-FF.
userId No String The ID of the user whose extension is bound to Line 1 of the phone. The extension number is resolved by the system. If omitted, no extension is bound. You can obtain the ID using the Get Available Extensions for Phones 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<Batch_Result> The batch operation result.
Batch_Result
Parameter Type Description
totalCount Integer The total number of phones to operate on.
successCount Integer The number of phones operated on successfully.
failedCount Integer The number of phones that fail to be operated on.
successIds Array<String> The IDs of the phones operated on successfully.
failedItems Array<Failed_Item> The list of phones that fail to be operated on, with failure reasons.
Failed_Item
Parameter Type Description
id String The ID of the failed phone.
code String The error code of the failure.
message String The description of the failure reason.
mac String The MAC address of the failed phone.

Example

Request example

POST /uc-cautop/api/v1/phones/batch HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MDc2MTIyMCwiaWF0IjoxNzkwNzM5NjIwLCJqdGkiOiJiOWY2YTllMC1iNzI1LTQ0MWItOWM4MS0xNTViN2I2MzQzZTEiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.pLZvlI7wJOdlIe2rosP2RgmFghax1RIr5Bx8hM8hNHAcodWeuhl0y6mbm2Rx6HzEIaAqBv51HhtRgJCWUTt8H3Gx7gbGQ-oL-ay5QO8xKWyx9l-o2N9xqoxFnHEVJ1eODMtyZJdi0irq36D95TcDMFLgotKo9TeAr4WrZCelgLyawvyPw8aNpJqNvnc0giI43O8Ov_PjV8VZkQ3UPhWmQEoaLEc1QRCyV546snUuRZd2Ue_wJdW4jHQ5kxSLKq9RXIt-Y3RBweWh4ZALMfSEbOAcg9qzZkA-a_k1c4r2qmYeN1-RS10E7sBmx2KbrQ0JmtfRwzjIfowkZyaIv-5abg
Content-Type: application/json
x-tenant-code: jint
{
  "vendor": "Fanvil",
  "model": "A10",
  "templateId": "315428389935468544",
  "phones": [
    {
      "mac": "AA:BB:99:8A:C1:9A"
    },
    {
      "mac": "AA:BB:99:34:96:42"
    }
  ]
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "177e44d28722b78b35aca44c5b933c2a",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "totalCount": 2,
    "successCount": 2,
    "failedCount": 0,
    "successIds": [
      "363526077505622016",
      "363526077497233408"
    ],
    "failedItems": []
  }
}