List

This API gets a list of Unified CVP servers. This API does not provide paging functionality.

Parameters of Unified CVP Server - List

URL

https://<ipaddress>:8111/cvp-config /server.

HTTP Method

GET.

API Type

Synchronous.

Input/Output Format

JSON, XML.

Parameters

The following query parameters are specified using (q=) syntax.

q parameters:

Name: type

Description: Text parameter indicating the type of servers to be listed. No wildcard is allowed for this parameter, only allowed values should be used.

Required: No. If not present, all servers from the supported device types would be returned.

Values: VXML, MEDIA , CALL, VXML_STANDALONE, RPT (These values have been shortened from the previous spec, to avoid making query URLs too long. This change is being carried out with a long term view and with the reason that shorter values will avoid mistakes which can cause validation errors.)

Validations: Only allowed values should be there.

Notes: This parameter should be specified as URL query parameter. Currently only VXML and MEDIA will be implemented.

Example XML Request Payload

None.

Response 

<results>
     <servers>
<server> 
     <refurl>https://<ipaddress>:8111/cvp-config/server/{Id}</refurl>
     <hostname>name1</hostname>
      <ipaddr>IP1</ipaddr>
      <servertype>VXML</type>
</server>
<server> 
     <refurl>https://<ipaddress>:8111/cvp-config/server/{Id}</refurl>
     <hostname>>name2</hostname>
<ipaddr>IP2</ipaddr>
<type>VXML</type>
</server>
      </servers>
</results>