Dialed Number API for Avaya PG

Use the Dialed Number API to list the dialed numbers currently defined in the database, define new dialed numbers, view, and edit existing dialed numbers for Avaya PG.

URL

https://<server>/unifiedconfig/config/dialednumber/avayadialednumber

Operations

  • create: Creates one dialed number.

  • get: Returns all Avaya dialed numbers using the URL https://<server>/unifiedconfig/config/dialednumber/avayadialednumber.

  • update: Updates one dialed number.

Parameters

  • description: See Shared 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. The External Voice and Post Call Survey routing types cannot have the same dialed number string.

  • changeStamp: See Shared Parameters.

  • mediaRoutingDomain: A reference to the media routing domain (Media Routing Domain API) for the dialed number. See References.

  • callType: A reference to a call type 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.

  • peripheral: A unique identifier for the peripheral.

  • label: Name of the default label for the dialed number. The default label for the dialed number is used when the system software fails to determine a target for the call within the routing client's time-out threshold.

  • pcsEnabledDialedNumberPattern: Optional. Dialed Numbers (DN) or DN patterns to associate with the Post Call Survey number. The maximum character length is 512 that can contain comma separated list without any spaces. Applicable only when the Routing Type is 7 (Post Call Survey -Unified CVP). If the Routing Type is not 7, the system returns an error message.

  • ringtoneName: Optional. A file name that has the customized ringtone. The file name can have a maximum length of 256 characters. Internationalized characters are allowed. Applicable only when the Routing Type is 1 (External Voice - Unified CVP). If the Routing Type is not 1, the system returns an error message.

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

  • pcsEnabledDialedNumberPattern

See Search and Sort.

Advanced search parameters

The Dialed Number API also supports advanced search parameters, such as peripheral.

Following are the REST responses received when the REST API runs to configure the dialed number:

  • Success - Configuration changes persist in AW DB and synchronized with respective devices.

    Code: 200

    Response: Successfully saved

  • Partial Success - Configuration changes persist in AW DB, but failed to synchronize with one or more devices.

    Code: 201

    Response: Configuration update failed for one or more devices. (This occurs when the AW DB is updated but Sync with CVP failed.)

    Code: 503

    Response: The server is currently busy. Please try again later. (This occurs when data synchronization to a device is in progress.)

    Example API error:
    Code Snippet
    Copy<apiErrors>
<apiError>
<errorMessage>Configuration update failed for one or more devices.</errorMessage>
<errorType>PARTIAL_SUCCESS</errorType>
</apiError>
</apiErrors>
    Note

    The partial success generally occurs for dialed number configured with Post Call Survey (PCS) and/or Ringtone.

  • Failure- The configuration updates to AW DB is failed.

Example Get Response for Packaged CCE 4000 Agents and 12000 Agents Deployment

Code Snippet
Copy<dialedNumber>
  <description>test dialed number</description>
  <dialedNumberString>8885551212</dialedNumberString>
  <changeStamp>0</changeStamp>
  <mediaRoutingDomain>
    <refURL>[https://***.***.***.***/unifiedconfig/config/mediaroutingdomain/1]<refURL>
    <name>Cisco_Voice</name>
  </mediaRoutingDomain>
  <callType>
    <refURL>[https://***.***.***.***/unifiedconfig/config/calltype/(id)]</refURL>
    <name>calltype name</name>
  </callType>
  <dialedNumberRecords>
    <dialedNumberRecord>
      <id>10</id>
      <name>cvp1rc.8885551212</name>
    </dialedNumberRecord>
    <dialedNumberRecord>
      <id>11</id>
      <name>cvp2rc.8885551212</name>
    </dialedNumberRecord>
  </dialedNumberRecords>
  <peripheral>
    <id>5000</id>
  </peripheral>
  <defaultLabel>11223344</defaultLabel>
 </dialedNumber>