Get call forward rules list

Returns call forward rules sorted and filtered list with pagination options

Query Parameters

• limit integer

  Possible values: [10, 20, 30, 50]

  Number of items. Value by default is 10

• page_number integer

  Possible values: >= 1

  Page number

• sort_field string

  Field name (JSON Key in item entity)

• sort_type string

  Possible values: [asc, desc]

  Default value: asc

  Sort type (asc/desc)

• filter object

  Filtering options for call forwarding rules

Responses

• 200
• 400
• 401

---

OK

application/json

• Schema
• Example (from schema)
• Forwards
• Filtered Forwards

---

Schema

• list_items object[]

  List of Forwards

• list_option object

  This model describes settings that can be used to represent forward rule list

  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, 20, 30, 50]

  Limiting the display of the amount of data for one page

  total_pages integer

  The number of pages that hold the requested data

  current_page integer

  Possible values: >= 1

  Current page number

  sort object

  Available sorting options for the forward rule table

  field string

  Sorting field name

  asc boolean

  Sort direction

  available_fields string[]

  List of field names used for sorting

  filter object

  This model describes filtering options for forward rule list

  available_fields string[]

  Possible values: [forward_number]

  List of fields that can be used for filtering forward rules

  is_filtered boolean

  Indicates whether a filter is currently applied to the forward rule list

  available_filtering boolean

  Indicates whether filtering is available for the forward rule list

  filter_field string

  Possible values: [forward_number]

  Field used for filtering the forward rule list

  filter_type string

  Possible values: [equal]

  Filter type used for filtering the forward rule list

  filter_format string

  Possible values: [number]

  Filter value format used for filtering the forward rule list

  filter_value string

  Forward number used for filtering the forward rule list

{
  "list_items": [
    {
      "forward_entity_list": [
        "sip:[email protected]",
        "vizit:123",
        "sip:[email protected]"
      ],
      "forward_number": 101
    }
  ],
  "list_option": {
    "pagination": {
      "total_items": 18,
      "items_limit": 10,
      "total_pages": 2,
      "current_page": 1
    },
    "sort": {
      "field": "forward_number",
      "asc": true,
      "available_fields": [
        "forward_number"
      ]
    },
    "filter": {
      "available_fields": [
        "forward_number"
      ],
      "is_filtered": false,
      "available_filtering": true,
      "filter_field": "forward_number",
      "filter_type": "equal",
      "filter_format": "number",
      "filter_value": "101"
    }
  }
}

{
  "list_items": [
    {
      "forward_number": 101,
      "forward_entity_list": [
        "sip:[email protected]",
        "vizit:101",
        "sip:[email protected]"
      ]
    },
    {
      "forward_number": 102,
      "forward_entity_list": [
        "sip:[email protected]",
        "vizit:103",
        "sip:[email protected]"
      ]
    },
    {
      "forward_number": 103,
      "forward_entity_list": [
        "sip:[email protected]",
        "vizit:103",
        "sip:[email protected]"
      ]
    }
  ],
  "list_option": {
    "pagination": {
      "total_items": 18,
      "items_limit": 10,
      "total_pages": 2,
      "current_page": 1
    },
    "sort": {
      "asc": true,
      "field": "forward_number",
      "available_fields": [
        "forward_number"
      ]
    },
    "filter": {
      "available_filtering": true,
      "available_fields": [
        "forward_number"
      ],
      "is_filtered": false
    }
  }
}

{
  "list_items": [
    {
      "forward_number": 101,
      "forward_entity_list": [
        "sip:[email protected]",
        "vizit:101",
        "sip:[email protected]"
      ]
    }
  ],
  "list_option": {
    "pagination": {
      "total_items": 1,
      "items_limit": 10,
      "total_pages": 1,
      "current_page": 1
    },
    "sort": {
      "asc": true,
      "field": "forward_number",
      "available_fields": [
        "forward_number"
      ]
    },
    "filter": {
      "available_filtering": true,
      "available_fields": [
        "forward_number"
      ],
      "is_filtered": true,
      "filter_field": "forward_number",
      "filter_type": "equal",
      "filter_format": "number",
      "filter_value": "101"
    }
  }
}

Base errors for all entities

• Wrong pagination limit
• Wrong page number
• Wrong filter type
• Wrong filter field
• Wrong filter format
• Wrong filter value
• Wrong sort type
  Errors appeared only in log entities:
• Wrong time format
• Wrong time range: 'to' must be greater then 'from'
  Errors appeared in other entities:
• Wrong sort field

application/json

• Schema
• Example (from schema)
• Pagination Limit
• Pagination Page Number
• Sort type
• Sort field
• Filter type
• Filter field
• Filter value
• Filter format
• Time format
• Time range

---

Schema

• error string

  Error message

{
  "error": "Administrator rights required"
}

{
  "error": "Wrong pagination limit"
}

{
  "error": "Wrong page number"
}

{
  "error": "Wrong sort type"
}

{
  "error": "Wrong sort field"
}

{
  "error": "Wrong filter type"
}

{
  "error": "Wrong filter field"
}

{
  "error": "Wrong filter value"
}

{
  "error": "Wrong filter format"
}

{
  "error": "Wrong time format"
}

{
  "error": "Wrong time range: 'to' must be greater then 'from'"
}

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Log In

---

Schema

• error string

  Error message

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Loading...