Delete an Inbound Route

Deletes an inbound route. The inbound route is logically deleted.

Request URL

DELETE {base_url}/uc-cconfig/api/v1/inbound-routes/{id}

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 to delete. 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.
result Object<Inbound_Route> The deleted inbound route.
Inbound_Route
Parameter Type Description
id String The ID of the inbound route.
name String The name of the inbound route.
listOrder Integer The position of the inbound route in the route list.
description String The description of the inbound route.
didMatch Object<DID_Match_Info> The DID match configuration of the inbound route.
callerMatch Object<Caller_Match> The caller number match configuration of the inbound route.
trunkIds Array<String> The list of IDs of the trunks bound to the inbound route.
destination Object<Destination> The destination of the inbound route.
createdAt String The time when the inbound route was created, in Unix timestamp format (milliseconds).
updatedAt String The time when the inbound route was last updated, in Unix timestamp format (milliseconds).
timeBasedRoutingEnabled Boolean

Whether time-based routing is enabled.

  • true: Time-based routing is enabled.
  • false: Time-based routing is disabled.
timeBasedRoutingProfileId String The ID of the business hours profile that time-based routing references.
timeBasedRoutingConfig Object<Time_Based_Routing_Config_Info> The time-based routing configuration.
DID_Match_Info
Parameter Type Description
mode String

The DID match mode:

  • DID_PATTERN
  • PATTERN_TO_EXT
  • RANGE
  • EXACT
patterns Array<String> The list of DID number patterns. This parameter is returned only when mode is DID_PATTERN.
patternWithExt String The DID pattern with the {{.Ext}} placeholder. This parameter is returned only when mode is PATTERN_TO_EXT.
mappingsCount Integer The number of DID mappings.
mappings Array<DID_Mapping_Detail> The DID mappings. This parameter is returned only when mode is EXACT.
didIdStart String The start ID of the DID record range. This parameter is returned only when mode is RANGE, and an empty string is returned in other modes.
didIdEnd String The end ID of the DID record range. This parameter is returned only when mode is RANGE, and an empty string is returned in other modes.
defaultDisplayFormatStart String The default display format of the DID at the range start.
defaultDisplayFormatEnd String The default display format of the DID at the range end.
didNameStart String The name of the DID at the range start.
didNameEnd String The name of the DID at the range end.
countryCodeStart String The country code of the DID at the range start.
countryCodeEnd String The country code of the DID at the range end.
didE164Start String The E.164 number of the DID at the range start.
didE164End String The E.164 number of the DID at the range end.
DID_Mapping_Detail
Parameter Type Description
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.
didId String The ID of the DID record. An empty string indicates that the DID reference is missing or invalid.
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.
Caller_Match
Parameter Type Description
patterns Array<String> The list of caller number patterns.
Destination
Parameter Type Description
type String

The type of the route destination:

  • HANGUP
  • USER
  • MATCH_SELECTED_USERS
  • MATCH_USER_RANGE
  • DID_TO_SPECIFIC_USER
  • IVR
  • EXTERNAL_NUMBER
  • RING_GROUP
  • QUEUE
  • USER_VOICEMAIL
  • GROUP_VOICEMAIL
  • PLAY_PROMPT
value String The value of the destination.
prefix String The outbound prefix. This parameter is returned only when type is EXTERNAL_NUMBER.
allowedUserIds Array<String> The list of IDs of the allowed users. This parameter is returned only when type is MATCH_SELECTED_USERS.
extensionStart String The start of the extension range. This parameter is returned only when type is MATCH_USER_RANGE.
extensionEnd String The end of the extension range. This parameter is returned only when type is MATCH_USER_RANGE.
repeatCount Integer The number of times the prompt is played. This parameter is returned only when type is PLAY_PROMPT.
Time_Based_Routing_Config_Info
Parameter Type Description
holidayHandling String

The handling method for holidays:

  • route
  • play_prompt
  • ignore
businessHoursDestination Object<Destination> The destination during business hours.
outsideDestination Object<Destination> The destination outside business hours.
holidayDestination Object<Destination> The destination on holidays.

Example

Request example

DELETE /uc-cconfig/api/v1/inbound-routes/374469842103001088 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: colortest2

Response example

HTTP/1.1 200 OK
{
  "requestId": "4f988f4378b2a1301f5e81ce357b56ff",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "id": "374469842103001088",
    "name": "",
    "listOrder": 0,
    "description": "",
    "didMatch": null,
    "callerMatch": null,
    "trunkIds": [],
    "destination": null,
    "createdAt": "0",
    "updatedAt": "0",
    "timeBasedRoutingEnabled": false,
    "timeBasedRoutingProfileId": ""
  }
}