Update a DID

Updates a single DID by its ID. Supports partial update: only the fields present in the request body are changed, omitted fields keep their current values.

Request URL

PUT {base_url}/uc-cconfig/api/v1/dids/{id}

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.
Path parameters
Parameter Required Type Description
id Yes String The ID of the DID to update. You can obtain the ID using the Query DID List interface.
Body parameters
Parameter Required Type Description
didName No String The DID name, maximum 127 characters. Chinese characters are weighted 3:1 against English. An empty string clears the value.
destination No String The DID call destination. An empty string clears the value.
trunkIds No Array<String> The list of trunk IDs to bind. An empty array clears the binding; omitting this field leaves it unchanged.
countryCode No String The ISO 3166-1 country code, for example CN, US. Use XX for Unknown Country.
didNumber No String The DID number. Supports formatting characters, maximum 31 characters.
numberType No String The number type. Supports custom values, maximum 127 characters.
assignedTenant No String The tenant to assign. An empty string cancels the assignment.
nullFields No Array<String> The list of fields to set to NULL (the request body does not accept null values).
remark No String The remark. Maximum 1024 characters. Chinese characters are weighted 3:1 against English.
confirmResellerReset No Boolean The reseller reset confirmation: true = confirm and save, revoking the reseller's access; omitted or false = do not save, and the response carries the reseller_reset_warning details.

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<DID_Data> The updated DID data.
DID_Data
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<Reseller_Reset_Warning> The reseller reset warning details.
Note:

When the request changes trunkIds such that the currently assigned reseller loses usage rights, the response returns resellerResetWarning with saved set to false, and the change is not persisted. Repeat the request with confirmResellerReset set to true to save the change and recall the reseller.

Reseller_Reset_Warning
Parameter Type Description
saved Boolean Whether the operation was saved. Always false when a warning exists.
items Array<Reseller_Reset_Item> The list of affected DID entries.
Reseller_Reset_Item
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

PUT /uc-cconfig/api/v1/dids/375602272973185024 HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJhcHBfa2V5Ijoic2xOdnQzaHc1NXB2Vm5HRlNhR2ZOVTNmMWxYQ3lpa08iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MzYzODk1MywiaWF0IjoxNzkzNjE3MzUzLCJqdGkiOiIzMTg2YTYxNi0yOTdjLTRkNzMtODRkZC1lNzNkODE1ZDRmYmYiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.FR6Pir4F-5uDAVqebnXRnVymCoQlN5je95U9NywVCtrMLYnEjMNH1cw20Gz81DothBN4jXNzWT6A1V-DcghGQyjNjAAqfwTLYxAeksE_h8myiynhB67sB0VS6EPv8MTkEdVk4dmujjkQXU2yFVzlpQNvLwQhFDqpxlwpsom-Uk5jNh-JpWzpWJs9JP9Bn3oIZAwv847fXkvG_rSkBc2AAHf3y-zpRZ8nEZF4WDSCoEMfbsTdT5qahecCcThvJesTGFWyA1eW4xEUDplwZpnO-s7DIsbUrSO_123ylqOz0YZm2EirVJwr7j4KPzXFtTZdcvZ6t5mI9ofDbXG0woeTOw
Content-Type: application/json
{
  "didName": "doc-did-a-updated",
  "numberType": "Mobile"
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "f7f022f7dd54b83c5f04595db4fe78b3",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "id": "375602272973185024",
    "didNumber": "19995554001",
    "didName": "doc-did-a-updated",
    "destination": "extension:1001",
    "creator": "3076913644915998720",
    "assignedTenant": "",
    "trunkIds": [],
    "createdAt": "1793617760229",
    "updatedAt": "1793617760467",
    "didE164": "+19995554001",
    "countryCode": "US",
    "countryCallingCode": "1",
    "nationalNumber": "9995554001",
    "numberType": "Mobile",
    "defaultDisplayFormat": "(999) 555-4001",
    "remark": "doc-test",
    "assignedReseller": "",
    "ownerType": "admin"
  }
}
Note:

T

Note:

h

Note:

e

Note:
Note:

Note:

t

Note:

r

Note:

u

Note:

n

Note:

k

Note:

I

Note:

d

Note:

s

Note:

Note:
Note:

a

Note:

r

Note:

r

Note:

a

Note:

y

Note:
Note:

r

Note:

e

Note:

t

Note:

u

Note:

r

Note:

n

Note:

e

Note:

d

Note:
Note:

b

Note:

y

Note:
Note:

t

Note:

h

Note:

i

Note:

s

Note:
Note:

i

Note:

n

Note:

t

Note:

e

Note:

r

Note:

f

Note:

a

Note:

c

Note:

e

Note:
Note:

i

Note:

s

Note:
Note:

e

Note:

m

Note:

p

Note:

t

Note:

y

Note:
Note:

a

Note:

f

Note:

t

Note:

e

Note:

r

Note:
Note:

t

Note:

h

Note:

e

Note:
Note:

u

Note:

p

Note:

d

Note:

a

Note:

t

Note:

e

Note:

,

Note:
Note:

b

Note:

e

Note:

c

Note:

a

Note:

u

Note:

s

Note:

e

Note:
Note:

t

Note:

h

Note:

i

Note:

s

Note:
Note:

i

Note:

n

Note:

t

Note:

e

Note:

r

Note:

f

Note:

a

Note:

c

Note:

e

Note:
Note:

d

Note:

o

Note:

e

Note:

s

Note:
Note:

n

Note:

o

Note:

t

Note:
Note:

r

Note:

e

Note:

t

Note:

u

Note:

r

Note:

n

Note:
Note:

t

Note:

h

Note:

e

Note:
Note:

t

Note:

r

Note:

u

Note:

n

Note:

k

Note:
Note:

b

Note:

i

Note:

n

Note:

d

Note:

i

Note:

n

Note:

g

Note:

s

Note:

.

Note:
Note:

U

Note:

s

Note:

e

Note:
Note:

t

Note:

h

Note:

e

Note:
Note:

G

Note:

e

Note:

t

Note:
Note:

a

Note:
Note:

D

Note:

I

Note:

D

Note:
Note:

i

Note:

n

Note:

t

Note:

e

Note:

r

Note:

f

Note:

a

Note:

c

Note:

e

Note:
Note:

t

Note:

o

Note:
Note:

r

Note:

e

Note:

a

Note:

d

Note:
Note:

t

Note:

h

Note:

e

Note:
Note:

c

Note:

u

Note:

r

Note:

r

Note:

e

Note:

n

Note:

t

Note:
Note:

t

Note:

r

Note:

u

Note:

n

Note:

k

Note:
Note:

b

Note:

i

Note:

n

Note:

d

Note:

i

Note:

n

Note:

g

Note:

s

Note:

.