Ресурс

Incoming Call Policy

Manage incoming call routing policies with escalation rules for on-call teams

Модель Incoming Call Policy

Свойства

Имя
_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
Имя
name
Тип
TextОбязательно
Описание
Any friendly name of this policy
Имя
description
Тип
Long Text
Описание
Friendly description that will help you remember
Имя
slug
Тип
SlugОбязательно
Описание
Friendly globally unique name for your object
Имя
routingPhoneNumber
Тип
Phone
Описание
The phone number for incoming calls to this policy
Имя
callProviderPhoneNumberId
Тип
Text
Описание
The call provider's ID for the phone number (e.g., Twilio SID)
Имя
phoneNumberCountryCode
Тип
Text
Описание
Country code of the phone number (US, GB, etc.)
Имя
phoneNumberAreaCode
Тип
Text
Описание
Area code of the phone number
Имя
phoneNumberPurchasedAt
Тип
Date
Описание
When the phone number was purchased
Имя
greetingMessage
Тип
Long Text
Описание
Custom TTS greeting message for incoming calls
Имя
noAnswerMessage
Тип
Long Text
Описание
Message when escalation is exhausted and no one answers
Имя
noOneAvailableMessage
Тип
Long Text
Описание
Message when no one is on-call or reachable
Имя
isEnabled
Тип
BooleanОбязательно
Описание
Enable or disable this incoming call policy
Имя
repeatPolicyIfNoOneAnswers
Тип
BooleanОбязательно
Описание
Restart from first rule if all fail
Имя
repeatPolicyIfNoOneAnswersTimes
Тип
NumberОбязательно
Описание
Maximum repeat attempts if no one answers
Имя
labels
Тип
Label
Описание
Relation to Labels Array where this object is categorized in.
Имя
projectCallSMSConfig
Тип
Entity
Описание
Optional project-level Twilio configuration. If set, uses this config instead of global config and billing does not apply.
Имя
projectCallSMSConfigId
Тип
Object ID
Описание
ID of the project-level Twilio configuration. If set, uses this config instead of global config and billing does not apply.
Имя
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/get-list

Список

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

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

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

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

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

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

POST

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

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "isEnabled": true,
    "name": true,
    "projectId": true,
    "repeatPolicyIfNoOneAnswers": true,
    "repeatPolicyIfNoOneAnswersTimes": true
  },
  "query": {
    "name": "Example name"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "37738d80-28fe-11f1-b591-3fdcef396aba",
      "isEnabled": true,
      "name": "Example name",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "repeatPolicyIfNoOneAnswers": true,
      "repeatPolicyIfNoOneAnswersTimes": 100
    },
    {
      "_id": "37738d81-28fe-11f1-b591-3fdcef396aba",
      "isEnabled": true,
      "name": "Example name",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "repeatPolicyIfNoOneAnswers": true,
      "repeatPolicyIfNoOneAnswersTimes": 100
    },
    {
      "_id": "37738d82-28fe-11f1-b591-3fdcef396aba",
      "isEnabled": true,
      "name": "Example name",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "repeatPolicyIfNoOneAnswers": true,
      "repeatPolicyIfNoOneAnswersTimes": 100
    }
  ]
}

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

Получить по ID

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

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

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

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

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

POST

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

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "isEnabled": true,
    "name": true,
    "projectId": true,
    "repeatPolicyIfNoOneAnswers": true,
    "repeatPolicyIfNoOneAnswersTimes": true
  }
}

Ответ

{
  "_id": "37738d80-28fe-11f1-b591-3fdcef396aba",
  "isEnabled": true,
  "name": "Example name",
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "repeatPolicyIfNoOneAnswers": true,
  "repeatPolicyIfNoOneAnswersTimes": 100
}

POST/api/incoming-call-policy/count

Количество

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

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

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

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

POST

/api/incoming-call-policy/count

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "query": {
    "name": "Example name"
  }
}

Ответ

{
  "count": 107
}

POST/api/incoming-call-policy

Создать Incoming Call Policy

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

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

POST

/api/incoming-call-policy

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "isEnabled": true,
    "name": "Example name",
    "projectId": "550e8400-e29b-41d4-a716-446655440000",
    "repeatPolicyIfNoOneAnswers": true,
    "repeatPolicyIfNoOneAnswersTimes": 100
  }
}

Ответ

{
  "_id": "37738d80-28fe-11f1-b591-3fdcef396aba",
  "isEnabled": true,
  "name": "Example name",
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "repeatPolicyIfNoOneAnswers": true,
  "repeatPolicyIfNoOneAnswersTimes": 100
}

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

Обновить по ID

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

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

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

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

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

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

PUT

/api/incoming-call-policy/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "isEnabled": true,
    "name": "Example name",
    "repeatPolicyIfNoOneAnswers": true
  }
}

Ответ

{}

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

Удалить по ID

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

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

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

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

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

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

DELETE

/api/incoming-call-policy/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Ответ

{}

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

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

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

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

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

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

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

Project Owner
Project Admin
Project Member
Create Incoming Call Policy

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

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

Project Owner
Project Admin
Project Member
Edit Incoming Call Policy

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

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

Project Owner
Project Admin
Project Member
Delete Incoming Call Policy