Get DID Mappings of an Inbound Route

Retrieves the DID mappings of an inbound route. The DID mappings map DID numbers to specific users, and take effect when the DID match mode of the route is EXACT.

Request URL

GET {base_url}/uc-cconfig/api/v1/inbound-routes/{id}/did-mappings

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.

Path parameters


Parameter	Required	Type	Description
id	Yes	String	The ID of the inbound route. You can obtain the ID using the Search Inbound Routes 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.
results	Array<DID_Mapping>	The list of DID mappings of the inbound route.

DID_Mapping


Parameter	Type	Description
didId	String	The ID of the DID record. An empty string indicates that the DID reference is missing or invalid.
userId	String	The ID of the user that the DID number is mapped to.
extension	String	The extension number of the user.
userName	String	The name of the user.
defaultDisplayFormat	String	The default display format of the DID number.
didName	String	The name of the DID number.
countryCode	String	The country code of the DID number.
didE164	String	The E.164 number of the DID.

Example

Request example

GET /uc-cconfig/api/v1/inbound-routes/{id}/did-mappings HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJhcHBfa2V5Ijoic2xOdnQzaHc1NXB2Vm5HRlNhR2ZOVTNmMWxYQ3lpa08iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MzM2OTMwNCwiaWF0IjoxNzkzMzQ3NzA0LCJqdGkiOiJmMzVlZDk0MC01MDEyLTRjMjctOGE0NS0wM2EzYTVhZTFmMjUiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.XOFg1WgfepDISEY6GwoJLoh2fclbzYlN1T0KABLNw2scP9Ew_OHvMHNBIqVmjnfj-L5tUDzRJ1jMUtUUWKOAXShaKl1IORVQDV2FwJYv7fqnrjW_HFCDmTGDim47PD99ZgRqUrU1-zCXrO9a4_fov2W_3rlSrPVVb2DGxoq4pE1PQ94SUsQ9JnPC4NaLY_RnoUeNmlFJ8_3PUVLIKgxYuhDt1YSR6qX9Qy4r9cEkMidG5Ae1rDceDk1rsnxddMOaoFzTu0WS0FJTRf8w5SnKVLueIh6LkRaIgdFRO4L3-DmseAj-ZaYgEATExvVAB3M_5q8oemiIqQepbtq66yW06g
x-tenant-code: jint

Response example

HTTP/1.1 200 OK
{
  "requestId": "aef69070a7afc40841487e3f7775bf27",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "results": []
}