Dialed numbers are string values used to select the appropriate routing script so that a voice call or a non-voice task (such as an email or a request for a web chat) can be delivered to an agent.
Use the Dialed Number API to list the dialed numbers currently defined in the database, define new dialed numbers, and view, edit, and delete existing dialed numbers.
URL
https://<server>/unifiedconfig/config/dialednumber
Operations
- create: Creates one dialed number.
- delete: Marks one dialed number for deletion.
- get: Returns one dialed number, using the URL https://<server>/unifiedconfig/config/dialednumber/<id>.
- list: Retrieves a list of dialed numbers.
- update: Updates one dialed number.
Parameters
- dialedNumberString: Required. Value used to route the call or direct the non-voice task. A unique string for the routing type. Maximum of 25 characters.
- changeStamp: See Shared parameters.
- description: See Shared parameters.
- department: A reference to the department (Department API), including the refURL and name. See References.
- routingType: Specifies where a call or non-voice task request originates.
- 1: External Voice. Calls come from Unified CVP. When creating a Dialed Number using this type, a dialed number database record is created for each Unified CVP routing client.
- 2: Internal Voice. Calls come from a Unified CM phone.
- 3: Outbound. Calls that come from the Outbound Option Dialer.
- 4: Multichannel. Requests that come from an EIM/WIM or SocialMiner.
- callType: A reference to a call type (Call Type API) for this dialed number, including a refURL and name. See References.
- dialedNumberRecords: A collection of dialed number record entries each containing the id and name of a dialed number database record. Read-only.
- mediaRoutingDomain: A reference to the media routing domain (Media Routing Domain API) for the dialed number. See References.
Search and sort values
The following table shows the parameters that are searched and the parameters that are sortable.
Search parameters |
Sort parameters |
- dialedNumberString
- description
|
- dialedNumberString (default)
- description
|
See Search and Sort.
Advanced search parameters
The Dialed Number API also supports advanced search parameters, such as routing type.
- routingType:<type> Finds all dialed numbers with the specified routing type value. Valid types match those in the routingType parameter.
- routingType:1 Returns all dialed numbers with an external voice routing type.
Example get response
<dialedNumber>
<refURL>[/unifiedconfig/config/dialedNumber/(id)]</refURL>
<description>test dialed number</description>
<dialedNumberString>8885551212</dialedNumberString>
<routingType>1</routingType>
<changeStamp>0</changeStamp>
<mediaRoutingDomain>
<refURL>[/unifiedconfig/config/mediaroutingdomain/1]<refURL>
<name>Cisco_Voice</name>
</mediaRoutingDomain>
<dialedNumberRecords>
<dialedNumberRecord>
<id>10</id>
<name>cvp1rc.8885551212</name>
</dialedNumberRecord>
<dialedNumberRecord>
<id>11</id>
<name>cvp2rc.8885551212</name>
</dialedNumberRecord>
<dialedNumberRecord>
<id>12</id>
<name>cvp3rc.8885551212</name>
</dialedNumberRecord>
<dialedNumberRecord>
<id>13</id>
<name>cvp4rc.8885551212</name>
</dialedNumberRecord>
</dialedNumberRecords>
</dialedNumber>