Get call forward rules list

Returns call forward rules sorted list with pagiantion 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)

Responses

• 200
• 400
• 401

---

OK

application/json

• Schema
• Example (from schema)
• Forwards

---

Schema

• list_items object[]
• 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, 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

  Available sorting options for the forward rule table

  field string

  Sorting field name

  asc boolean

  Direction of sorting

  available_fields string[]

  Available for sorting fields names

{
  "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"
      ]
    }
  }
}

{
  "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"
      ]
    }
  }
}

• Wrong pagination options
• Wrong sort options

application/json

• Schema
• Example (from schema)
• Pagination
• Sort

---

Schema

• error string

{
  "error": "Wrong JSON body"
}

{
  "error": "Wrong pagination options"
}

{
  "error": "Wrong sort options"
}

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Log In

---

Schema

• error string

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Loading...