Bulk Delete DIDs

Deletes multiple DIDs in a single batch operation (logical delete).

Request URL

DELETE {base_url}/uc-cconfig/api/v1/dids/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
ids Yes Array<String> The list of DID IDs to delete (1–1000 entries, each ID greater than 0).

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<BatchDeleteResult> The batch delete result.
BatchDeleteResult
Parameter Type Description
successCount Integer The number of DIDs successfully deleted.
failedCount Integer The number of DIDs that failed to delete.
failures Array<BatchFailure> The list of failed entries.
results Array<DIDData> The list of deleted DID data.
ownFailures Array<BatchFailure> The list of DIDs that conflict with DIDs under the current user.
otherFailures Array<BatchFailure> The list of DIDs that conflict with DIDs under other users.
resellerResetWarning Object<ResellerResetWarning> The reseller reset warning details.
BatchFailure
Parameter Type Description
id String The DID ID (0 when creation failed).
errorCode String The error status code.
errorMessage String The reason for the failure.
didNumber String The DID number used in the range creation.
defaultDisplayFormat String The default display format of the existing conflicting DID.
DIDData
Parameter Type Description
id String The DID ID.
didNumber String The DID number (original input, may contain formatting characters).
didName String The DID name.
destination String The DID call destination, for example extension:1001, ivr:sales.
creator String The user ID of the creator.
assignedTenant String The tenant currently assigned to this DID (null = unassigned).
trunkIds Array<String> The list of bound trunk IDs.
createdAt String The creation time as a millisecond timestamp.
updatedAt String The update time as a millisecond timestamp.
didE164 String The full E.164 format number. For Unknown Country, stores nationalNumber.
countryCode String The ISO 3166-1 country code, for example CN, US. XX indicates Unknown Country.
countryCallingCode String The country calling code, for example 86, 1. Empty for Unknown Country.
nationalNumber String The local number (country code stripped, cleaned digits only).
numberType String The number type, for example Local, Mobile, Toll-free. Supports custom values.
defaultDisplayFormat String The default display format, for example (261) 111-1127.
remark String The remark.
assignedReseller String The assigned reseller ID (empty = My Tenant).
ownerType String The ownership type (admin or reseller). Immutable after creation.
resellerResetWarning Object<ResellerResetWarning> The reseller reset warning details.
ResellerResetWarning
Parameter Type Description
saved Boolean Whether the operation was saved. Always false when a warning exists.
items Array<ResellerResetItem> The list of affected DID entries.
ResellerResetItem
Parameter Type Description
didDisplay String The affected DID number (default display format).
resellerEmail String The email of the currently assigned reseller.
tenantName String The tenant occupancy name (returned when the DID has been assigned to a tenant; empty otherwise).

Example

Request example

DELETE /uc-cconfig/api/v1/dids/batch HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MDc0ODc3OCwiaWF0IjoxNzkwNzI3MTc4LCJqdGkiOiJlZTQwMmQzNC03YjQ5LTQ4YmUtYWM0Yi02NDMyMDkzZDBhZDQiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.mq9d6uoAWxFZ4LJQSdWtSfp3jWK2-5-Nq-YJqA2p5qyN7ClRmxrZdeA9WolJsO7ONIKZfhqfjEYyCZeepU5iYJvShEJX2XlGrSfu9bkX8bO9byMq9pH_fxHmAyVnfu1R6Uy9c4YvQS6QW5iZmnTOjnV7Tzp0HarGi-D6rIzRYhm87ctWoNwtrDrFjB6WxZl-la1_NIOx9_LLlvewB-xoSxJRxXC7xOP-Xy5GC7amqytS8nplu0GwqmHu8PxEkJ3LeDWrSPqkLQqULdyzfsC0e2iJthEvLX7STMH7jSvLnjw7TH7cBLPsg-NdurAZ31TC3H5q4oKGKL0WBAJmrnAcQg
Content-Type: application/json
x-tenant-code: jint
{
  "ids": [
    "363479419887095808",
    "363479419887095809",
    "363479419887095810"
  ]
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "successCount": 3,
    "failedCount": 0,
    "failures": [],
    "results": [
      {
        "id": "363479419887095808",
        "didNumber": "19990000010",
        "didName": "doc-test-range",
        "...": "..."
      },
      {
        "id": "363479419887095809",
        "didNumber": "19990000011",
        "...": "..."
      },
      {
        "id": "363479419887095810",
        "didNumber": "19990000012",
        "...": "..."
      }
    ],
    "ownFailures": [],
    "otherFailures": [],
    "resellerResetWarning": null
  }
}

(condensed — 3 entries in the results array, showing all with abbreviated fields)