Retrieve all Network IVR Lists
This function retrieves all Network IVR Lists from the client account.
URL
GET {baseURL}/networkIVRLists
Parameters
None
Responses
If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.
Returned Data (200 OK)
A JSON Structure containing the following fields:
Field | Type | Data |
---|---|---|
filter | String | The applied filter. This is reserved for future use. |
limitStart | Integer | The first record index. Currently 0, reserved for future use. |
limitPageSize | Integer | The number of records. -1 indicates all records. Reserved for future use. |
records | NetworkIVRList [] | An array of records. |
count | Integer | The number of records returned. |
orderBy | String | The field used to sort the records. |
ascending | Boolean | Whether the array of records is sorted ascending or descending. |
status | Integer | The return code (also provided by the http status code). |
Example
{ "filter": "", "limitStart": 0, "limitPageSize": -1, "records": [ { "ClientsID": 1, "ID": 9, "Name": "Campaign List" }, ... { "ClientsID": 1, "ID": 3, "Name": "Routing" } ], "count": 11, "orderBy": "Name", "ascending": true, "status": 200 }
Retrieve the Entries in a Network IVR List
This function retrieves the entries in a network IVR list.
URL
GET {baseURL}/networkIVRLists/{networkIVRListsID}
Parameters
None.
Responses
If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.
Returned Data (200 OK)
A JSON Structure containing the following fields:
Field | Type | Data |
---|---|---|
filter | String | The applied filter. This is reserved for future use. |
limitStart | Integer | The first record index. Currently 0, reserved for future use. |
limitPageSize | Integer | The number of records. -1 indicates all records. Reserved for future use. |
records | NetworkIVRListEntry [] | An array of network IVR list entries. |
count | Integer | The number of records returned. |
orderBy | String | The field used to sort the records. |
ascending | Boolean | Whether the array of records is sorted ascending or descending. |
status | Integer | The return code (also provided by the http status code). |
Example
{ "filter": "", "limitStart": 0, "limitPageSize": -1, "records": [ { "Field4": null, "Field2": "Field 2", "Field3": "Field 3", "bMarkedForSend": null, "ID": 22, "NetworkIVRListsID": 9, "Field1": "Key 22" }, ... { "Field4": null, "Field2": "Field 2", "Field3": "Field 3", "bMarkedForSend": null, "ID": 24, "NetworkIVRListsID": 9, "Field1": "Key 24" } ], "count": 238, "orderBy": "", "ascending": true, "status": 200 }