Ресурс

Incoming Call Policy Escalation Rule

Manage escalation rules for incoming call policies that define who to call and in what order

Модель Incoming Call Policy Escalation Rule

Свойства

Имя
_id
Тип
Object ID
Описание
ID of this object
Имя
createdAt
Тип
Date
Описание
Date and Time when the object was created.
Имя
updatedAt
Тип
Date
Описание
Date and Time when the object was updated.
Имя
project
Тип
Project
Описание
Relation to Project Resource in which this object belongs
Имя
projectId
Тип
Object IDОбязательно
Описание
ID of your Project in which this object belongs
Имя
incomingCallPolicy
Тип
Incoming Call Policy
Описание
Relation to the parent Incoming Call Policy
Имя
incomingCallPolicyId
Тип
Object IDОбязательно
Описание
ID of the parent Incoming Call Policy
Имя
name
Тип
Text
Описание
Rule name (e.g., 'Primary On-Call', 'Backup Engineer')
Имя
description
Тип
Long Text
Описание
Optional description of this escalation rule
Имя
order
Тип
Number
Описание
Execution order (1, 2, 3...)
Имя
escalateAfterSeconds
Тип
NumberОбязательно
Описание
Seconds before escalating to next rule
Имя
onCallDutyPolicySchedule
Тип
On-Call Policy Schedule
Описание
Reference to on-call schedule (mutually exclusive with user)
Имя
onCallDutyPolicyScheduleId
Тип
Object ID
Описание
ID of the on-call schedule to route to (mutually exclusive with userId)
Имя
user
Тип
User
Описание
Direct user reference (mutually exclusive with on-call schedule)
Имя
userId
Тип
Object ID
Описание
ID of the user to route to directly (mutually exclusive with onCallDutyPolicyScheduleId)
Имя
createdByUser
Тип
User
Описание
Relation to User who created this object (if this object was created by a User)
Имя
createdByUserId
Тип
Object ID
Описание
User ID who created this object (if this object was created by a User)

GETorPOST/api/incoming-call-policy-escalation-rule/get-list

Список

Этот метод возвращает постраничный список ваших объектов «Incoming Call Policy Escalation Rule». По умолчанию на странице до десяти записей.

Необязательные query-параметры

limit
число
Сколько объектов вернуть. По умолчанию 10, максимум 100
skip
число
Сколько объектов пропустить (для пагинации)

Необязательное тело запроса

query
Чтобы фильтровать Incoming Call Policy Escalation Rule, укажите запрос здесь. Подробнее: написание запросов.
select
По умолчанию возвращается только ID; для других полей используйте select. Подробнее: как выбирать поля.
sort
По умолчанию сортировка по дате создания. Порядок можно изменить — см. раздел «Сортировка» в типах данных.

Запрос списка

POST

/api/incoming-call-policy-escalation-rule/get-list?skip=0&limit=10

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "escalateAfterSeconds": true,
    "incomingCallPolicyId": true,
    "projectId": true,
    "_id": true,
    "createdAt": true
  },
  "query": {
    "description": "Example description"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "3773b490-28fe-11f1-b591-3fdcef396aba",
      "escalateAfterSeconds": 100,
      "incomingCallPolicyId": "550e8400-e29b-41d4-a716-446655440000",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "createdAt": "2024-01-15T10:30:00.000Z"
    },
    {
      "_id": "3773b491-28fe-11f1-b591-3fdcef396aba",
      "escalateAfterSeconds": 100,
      "incomingCallPolicyId": "550e8400-e29b-41d4-a716-446655440000",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "createdAt": "2024-01-15T10:30:00.000Z"
    },
    {
      "_id": "3773b492-28fe-11f1-b591-3fdcef396aba",
      "escalateAfterSeconds": 100,
      "incomingCallPolicyId": "550e8400-e29b-41d4-a716-446655440000",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "createdAt": "2024-01-15T10:30:00.000Z"
    }
  ]
}

GETorPOST/api/incoming-call-policy-escalation-rule/:id/get-item

Получить по ID

Возвращает объект «Incoming Call Policy Escalation Rule» по идентификатору.

id
строка
ID объекта

Необязательное тело запроса

select
По умолчанию возвращается только ID; для других полей используйте select. Подробнее: как выбирать поля.

Запрос одного объекта

POST

/api/incoming-call-policy-escalation-rule/:id/get-item

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "escalateAfterSeconds": true,
    "incomingCallPolicyId": true,
    "projectId": true,
    "_id": true,
    "createdAt": true
  }
}

Ответ

{
  "_id": "550e8400-e29b-41d4-a716-446655440000",
  "escalateAfterSeconds": 100,
  "incomingCallPolicyId": "550e8400-e29b-41d4-a716-446655440000",
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "createdAt": "2024-01-15T10:30:00.000Z"
}

POST/api/incoming-call-policy-escalation-rule/count

Количество

Возвращает количество ваших объектов «Incoming Call Policy Escalation Rule».

Необязательное тело запроса

query
Чтобы фильтровать Incoming Call Policy Escalation Rule, укажите запрос здесь. Подробнее: написание запросов.

Запрос количества

POST

/api/incoming-call-policy-escalation-rule/count

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "query": {
    "description": "Example description"
  }
}

Ответ

{
  "count": 107
}

POST/api/incoming-call-policy-escalation-rule

Создать Incoming Call Policy Escalation Rule

Создаёт новый объект.

Запрос создания

POST

/api/incoming-call-policy-escalation-rule

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "escalateAfterSeconds": 100,
    "incomingCallPolicyId": "550e8400-e29b-41d4-a716-446655440000",
    "projectId": "550e8400-e29b-41d4-a716-446655440000",
    "createdByUser": "Example created by user",
    "createdByUserId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Ответ

{
  "_id": "550e8400-e29b-41d4-a716-446655440000",
  "escalateAfterSeconds": 100,
  "incomingCallPolicyId": "550e8400-e29b-41d4-a716-446655440000",
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "createdAt": "2024-01-15T10:30:00.000Z"
}

PUT/api/incoming-call-policy-escalation-rule/:id

Обновить по ID

Обновляет объект по ID.

Альтернативные методы

Если клиент не поддерживает PUT, используйте POST или GET с теми же заголовками и телом:

POST/api/incoming-call-policy-escalation-rule/:id/update-item

GET/api/incoming-call-policy-escalation-rule/:id/update-item

Запрос обновления

PUT

/api/incoming-call-policy-escalation-rule/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "escalateAfterSeconds": 100,
    "description": "Example description",
    "name": "Example name"
  }
}

Ответ

{}

DELETE/api/incoming-call-policy-escalation-rule/:id

Удалить по ID

Удаляет объект по ID.

Альтернативные методы

Если клиент не поддерживает DELETE, используйте POST или GET с теми же заголовками и телом:

POST/api/incoming-call-policy-escalation-rule/:id/delete-item

GET/api/incoming-call-policy-escalation-rule/:id/delete-item

Запрос удаления

DELETE

/api/incoming-call-policy-escalation-rule/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Ответ

{}

Права доступа

Для операций с ресурсом у ключа API должны быть права. При их отсутствии вернётся ответ 4xx.

Права на чтение

Нужны для чтения Incoming Call Policy Escalation Rule

Project Owner
Project Admin
Project Member
Read Incoming Call Policy Escalation Rule
Read All Project Resources

Права на создание

Нужны для создания Incoming Call Policy Escalation Rule

Project Owner
Project Admin
Project Member
Create Incoming Call Policy Escalation Rule

Права на обновление

Нужны для обновления Incoming Call Policy Escalation Rule

Project Owner
Project Admin
Project Member
Edit Incoming Call Policy Escalation Rule

Права на удаление

Нужны для удаления Incoming Call Policy Escalation Rule

Project Owner
Project Admin
Project Member
Delete Incoming Call Policy Escalation Rule