Create/Update multiple call forward rules with link_id

Create/Update multiple call forward rules with link_id

• This endpoint is used by Link management system
• If there is already forward rule with same forward_number it will be updated
• Available forward number patterns:
  • \d+ - digits only
  • ^sip:([0-9A-Za-z+\-_]*@)((\b((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?(?:\:\d{1,5})?)(\.|$)){4}\b)|([0-9]*[A-Za-z+\-_]+[0-9]*)((\.([0-9]*[A-Za-z+\-_]+[0-9]*))+\b))$ - full SIP URI, for example, sip:[email protected] or sip:[email protected]
  • ^sip:(\b((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?(?:\:\d{1,5})?)(\.|$)){4}\b)$ - SIP URI without name and host, for example sip:192.168.1.2

application/json

Request Body required

• list_items object[]

  list of forwarding rules

• List_options 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 fields

  field name	compare operators	type	values
  apartment_number	eq, nq	string

  available_filtering boolean required

  is filtering available

  is_filtered boolean required

  is filter applied

  available_fields object[] required

  list of fields available to filter by

  field_name string required

  data_type string required

  Possible values: [string, integer, timestamp]

  options object

  anyOf

  • MOD1
  • MOD2
  • MOD3
  • MOD4

  ---

  available_values object[]

  Possible values: >= 1

  This model provide filter available values

  available_range integer[]

  Possible values: >= 2, <= 2

  This model provide filter integer range

  available_values_localized string[]

  the field is used only for UI localization and is not a filter value.

  has_date boolean

  Default value: false

  true - has date, false - doesn't

  has_time boolean

  Default value: false

  true - has time, false - doesn't

  has_milliseconds boolean

  Default value: false

  true - has milliseconds, false - doesn't

  sort object

  Available sorting options for the forward rule table

  is_sorted boolean required

  Direction of sorting

  order string

  Possible values: [asc, desc]

  sorting order, asc - ascending, desc - descending

  available_fields string[] required

  Possible values: [forward_number]

  Available for sorting fields names

Responses

• 200
• 400
• 401

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• result object[]

  resulting array of ids

  link_id uuid

  Unique entity set by the server to bind some parameters with each other. By default return null value

  success boolean

  status of operation

  extended_info string

  Possible values: [created, updated, deleted, entity_not_found, number_taken_by_another_identifier, bound_time_profile_doesnt_exist, face_id_not_supported, number_of_face_identifiers_exceeded, number_of_identifiers_exceeded]

  Entity state information result

{
  "result": [
    {
      "link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
      "success": true,
      "extended_info": "created"
    }
  ]
}

{
  "result": [
    {
      "link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
      "success": true,
      "extended_info": "created"
    }
  ]
}

Wrong JSON body

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• error string

  error type/info

{
  "error": "Wrong JSON body"
}

{
  "error": "Wrong JSON body"
}

Log In

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• error string

  error message

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Loading...