Get call forward rules list

Query Parameters

limit integer required
Possible values: [10, 20, 30, 50]
Default value: 10
Number of items. Value by default is 10
pageNumber integer required
Possible values: >= 1
Default value: 1
Page number
sortField string
Field name (JSON Key in item entity)
sortType string
Possible values: [asc, desc]
Default value: asc
Sort type (asc/desc)
filter object
Filtering options

Responses

application/json

Schema
Example (from schema)
Example

Schema

list_items object[]
apartment_id string
forward_entity_list object[]
forward_entity string
list_option object
pagination object
Available pagination options for tables
total_items integer
The total number of items found and reflected across all pages
items_limit integer
Possible values: [10, 25, 50]
Limiting the display of the amount of data for one page
total_pages integer
Possible values: >= 1
The number of pages that hold the requested data
current_page integer
Possible values: >= 1
Current page number
sort object
field string
asc boolean
available_fields string[]
Possible values: [apartment_id]

{
  "list_items": [
    {
      "apartment_id": "101",
      "forward_entity_list": [
        {
          "forward_entity": "sip:[email protected]"
        },
        {
          "forward_entity": "sip:101"
        },
        {
          "forward_entity": "sip:[email protected]"
        }
      ]
    },
    {
      "apartment_id": "102",
      "forward_entity_list": [
        {
          "forward_entity": "sip:[email protected]"
        },
        {
          "forward_entity": "sip:103"
        },
        {
          "forward_entity": "sip:[email protected]"
        }
      ]
    },
    {
      "apartment_id": "103",
      "forward_entity_list": [
        {
          "forward_entity": "sip:[email protected]"
        },
        {
          "forward_entity": "sip:103"
        },
        {
          "forward_entity": "sip:[email protected]"
        }
      ]
    }
  ],
  "list_option": {
    "pagination": {
      "total_items": 18,
      "items_limit": 10,
      "total_pages": 2,
      "current_page": 1
    },
    "sort": {
      "field": "apartment_id",
      "asc": true,
      "available_fields": [
        "apartment_id"
      ]
    }
  }
}

{
  "list_items": [
    {
      "apartment_id": "101",
      "forward_entity_list": [
        {
          "forward_entity": "sip:[email protected]"
        },
        {
          "forward_entity": "201"
        },
        {
          "forward_entity": "sip:192.168.0.100"
        }
      ]
    },
    {
      "apartment_id": "102",
      "forward_entity_list": [
        {
          "forward_entity": "sip:[email protected]"
        },
        {
          "forward_entity": "203"
        },
        {
          "forward_entity": "sip:192.168.0.101"
        }
      ]
    },
    {
      "apartment_id": "103",
      "forward_entity_list": [
        {
          "forward_entity": "sip:[email protected]"
        }
      ]
    }
  ],
  "list_option": {
    "pagination": {
      "total_items": 18,
      "items_limit": 10,
      "total_pages": 2,
      "current_page": 1
    },
    "sort": {
      "field": "apartment_id",
      "asc": true,
      "available_fields": [
        "apartment_id"
      ]
    }
  }
}

Get call forward rules list​

Get call forward rules list