Versions Compared

Old Version 1

changes.mady.by.user jtel Support

Saved on

compared with

New Version Current

changes.mady.by.user jtel Support

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

A JSON Structure containing the following fields:

FieldTypeData
filterStringThe applied filter. This is reserved for future use.
limitStartIntegerThe first record index. Currently 0, reserved for future use.
limitPageSizeIntegerThe number of records. -1 indicates all records. Reserved for future use.
recordsNetworkIVRList []An array of records.
countIntegerThe number of records returned.
orderByStringThe field used to sort the records. 
ascendingBooleanWhether the array of records is sorted ascending or descending.
statusIntegerThe return code (also provided by the http status code).

Example

Translations Ignore


Code Block
languagejs
{
    "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
}


...

Translations Ignore


Code Block
GET {baseURL}/networkIVRLists/{networkIVRListsID}


Parameters

...

Parameter

Where

Type

Data

networkIVRListsIDURLIntegerThe ID of the NetworkIVRList.


Responses

If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.

...

A JSON Structure containing the following fields:

FieldTypeData
filterStringThe applied filter. This is reserved for future use.
limitStartIntegerThe first record index. Currently 0, reserved for future use.
limitPageSizeIntegerThe number of records. -1 indicates all records. Reserved for future use.
recordsNetworkIVRListEntry []An array of network IVR list entries.
countIntegerThe number of records returned.
orderByStringThe field used to sort the records. 
ascendingBooleanWhether the array of records is sorted ascending or descending.
statusIntegerThe return code (also provided by the http status code).

Example

Translations Ignore


Code Block
languagejs
{
    "filter": "",
    "limitStart": 0,
    "limitPageSize": -1,
    "records": [
        {
            "Field4": null,
            "Field2": "Field 2",
            "Field3": "Field 3",
            "bMarkedForSend": null,
            "ID": 22,
            "ExtraData": "null",
            "NetworkIVRListsID": 9,
            "Field1": "Key 22"
        },
...
        {
            "Field4": null,
            "Field2": "Field 2",
            "Field3": "Field 3",
            "bMarkedForSend": null,
            "ID": 24,
            "ExtraData": "{\n  \"a\": \"b\",\n  \"c\": \"d\"\n}",
            "NetworkIVRListsID": 9,
            "Field1": "Key 24"
        }
    ],
    "count": 238,
    "orderBy": "",
    "ascending": true,
    "status": 200
}


Add a new Entry to a Network IVR List

This function adds a new entry to a network IVR list.

URL

Translations Ignore


Code Block
POST {baseURL}/networkIVRLists/{networkIVRListsID}


Parameters

Parameter

Where

Type

Data

networkIVRListsIDURLIntegerThe ID of the NetworkIVRList.


Post Data

A JSON structure containing the new entry to add.

Example:

Code Block
{
    "Field1": "Field 1 Value", 
    "Field2": "Field 2 Value", 
    "Field3": "Field 3 Value",
    "Field4": "Field 4 Value",
    "ExtraData": "Extra Data Value"
}

Responses

If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.

Update an Entry in a Network IVR List

This function updates an entry in a network IVR list.

URL

Translations Ignore


Code Block
PATCH {baseURL}/networkIVRLists/{networkIVRListsID}/{networkIVRListEntryID}


Parameters

Parameter

Where

Type

Data

networkIVRListsIDURLIntegerThe ID of the NetworkIVRList.
networkIVRListEntryIDURLIntegerThe ID of the NetworkIVRListEntry to update.

Post Data

A JSON structure containing the data to change.

Example:

Code Block
{
    "Field1": "Field 1 Value", 
    "Field2": "Field 2 Value", 
    "Field3": "Field 3 Value",
    "Field4": "Field 4 Value",
    "ExtraData": "Extra Data Value" 
}

Responses

If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.

Delete an Entry in a Network IVR List

This function deletes an entry in a network IVR list.

URL

Translations Ignore


Code Block
DELETE {baseURL}/networkIVRLists/{networkIVRListsID}/{networkIVRListEntryID}


Parameters

Parameter

Where

Type

Data

networkIVRListsIDURLIntegerThe ID of the NetworkIVRList.
networkIVRListEntryIDURLIntegerThe ID of the NetworkIVRListEntry to update.

Responses

If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.