Skip to main content

Get call forward rules list

Returns call forward rules sorted list with pagiantion options

Query Parameters
  • limit integer required

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

    Default value: 10

    Number of items. Value by default is 10

  • page_number integer required

    Possible values: >= 1

    Default value: 1

    Page number

  • sort_field string

    field name see the list of available fields in sort.available_fields[]

  • sort_type string

    Possible values: [asc, desc]

    Default value: asc

    Sort type (asc/desc)

  • filter string

    Filtering expression:

    [field name] [compare operator] [value] <logical operator>...

    field namesee the list of available fields in filter.available_fields[].field_name
    valuesee the list of available values in filter.available_fields[].options object, may be missing
    compare operatorsee the list of available operators in filter.available_fields[].compare_operators array
    Compare operatorsDescriptionExample
    eqEqualname eq 'Sherlock Holmes'
    gtGreater thanbuilding gt 10
    ltLess thanbuilding lt 10
    nqNot equalname nq 'Sherlock Holmes'
    geGreater than or equalfloor ge 5
    leLess than or equalfloor le 5
    Logical operators
    andlogical ANDfloor le 10 and floor gt 3
    orlogical ORfloor le 3 or floor gt 10
    notlogical NOTnot floor le 3
    group operations
    ()group by priority(name eq 'Sherlock Holmes' or building eq 221) and floor gt 10
Responses

OK


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

  • filter object
  • available_filtering boolean
  • is_filtered boolean
  • available_fields object[]
  • field_name string
  • compare_operators string[]

    Possible values: [eq, gt, lt, nq, ge, le]

    Compare operatorsDescriptionExample
    eqEqualname eq 'Sherlock Holmes'
    gtGreater thanbuilding gt 10
    ltLess thanbuilding lt 10
    nqNot equalname nq 'Sherlock Holmes'
    geGreater than or equalfloor ge 5
    leLess than or equalfloor le 5
  • data_type string

    Possible values: [string, integer, timestamp]

  • options object
    anyOf

  • available_values string,integer[]

    Possible values: >= 1

    This model provide filter available values

  • 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

Loading...