Ресурс

Incoming Call Log Item

Child log for each escalation attempt / user ring within a call.

Модель Incoming Call Log Item

Свойства

Имя
_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 Status200 Project in which this object belongs
Имя
incomingCallLog
Тип
Incoming Call Log
Описание
Relation to the parent Incoming Call Log
Имя
incomingCallLogId
Тип
Object IDОбязательно
Описание
ID of the parent Incoming Call Log
Имя
incomingCallPolicyEscalationRule
Тип
Incoming Call Policy Escalation Rule
Описание
Which escalation rule was used
Имя
incomingCallPolicyEscalationRuleId
Тип
Object ID
Описание
ID of the escalation rule used
Имя
user
Тип
User
Описание
User who was called
Имя
userId
Тип
Object ID
Описание
User ID who was called
Имя
userPhoneNumber
Тип
Phone
Описание
Phone number that was dialed
Имя
status
Тип
TextОбязательно
Описание
Status of this dial attempt
Имя
statusMessage
Тип
Long Text
Описание
Additional status information
Имя
dialDurationInSeconds
Тип
Number
Описание
How long this dial lasted in seconds
Имя
callCostInUSDCents
Тип
Number
Описание
Cost for this dial attempt in USD cents
Имя
startedAt
Тип
Date
Описание
When dial started
Имя
endedAt
Тип
Date
Описание
When dial ended
Имя
isAnswered
Тип
BooleanОбязательно
Описание
Whether this user answered the call

GETorPOST/api/incoming-call-log-item/get-list

Список

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

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

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

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

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

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

POST

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

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "incomingCallLogId": true,
    "isAnswered": true,
    "projectId": true,
    "status": true,
    "_id": true
  },
  "query": {
    "status": "Example status"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "37736670-28fe-11f1-b591-3fdcef396aba",
      "incomingCallLogId": "550e8400-e29b-41d4-a716-446655440000",
      "isAnswered": true,
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "status": "Example status"
    },
    {
      "_id": "37736671-28fe-11f1-b591-3fdcef396aba",
      "incomingCallLogId": "550e8400-e29b-41d4-a716-446655440000",
      "isAnswered": true,
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "status": "Example status"
    },
    {
      "_id": "37736672-28fe-11f1-b591-3fdcef396aba",
      "incomingCallLogId": "550e8400-e29b-41d4-a716-446655440000",
      "isAnswered": true,
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "status": "Example status"
    }
  ]
}

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

Получить по ID

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

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

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

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

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

POST

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

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "incomingCallLogId": true,
    "isAnswered": true,
    "projectId": true,
    "status": true,
    "_id": true
  }
}

Ответ

{
  "_id": "550e8400-e29b-41d4-a716-446655440000",
  "incomingCallLogId": "550e8400-e29b-41d4-a716-446655440000",
  "isAnswered": true,
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "Example status"
}

POST/api/incoming-call-log-item/count

Количество

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

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

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

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

POST

/api/incoming-call-log-item/count

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "query": {
    "status": "Example status"
  }
}

Ответ

{
  "count": 107
}

POST/api/incoming-call-log-item

Создать Incoming Call Log Item

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

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

POST

/api/incoming-call-log-item

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "incomingCallLogId": "550e8400-e29b-41d4-a716-446655440000",
    "isAnswered": true,
    "projectId": "550e8400-e29b-41d4-a716-446655440000",
    "status": "Example status",
    "callCostInUSDCents": 100
  }
}

Ответ

{
  "_id": "550e8400-e29b-41d4-a716-446655440000",
  "incomingCallLogId": "550e8400-e29b-41d4-a716-446655440000",
  "isAnswered": true,
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "Example status"
}

PUT/api/incoming-call-log-item/:id

Обновить по ID

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

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

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

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

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

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

PUT

/api/incoming-call-log-item/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "isAnswered": true,
    "status": "Example status",
    "callCostInUSDCents": 100
  }
}

Ответ

{}

DELETE/api/incoming-call-log-item/:id

Удалить по ID

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

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

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

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

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

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

DELETE

/api/incoming-call-log-item/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Ответ

{}

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

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

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

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

Project Owner
Project Admin
Project Member
Read Incoming Call Log Item
Read All Project Resources

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

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

Project Owner
Project Admin

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

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

Project Owner
Project Admin

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

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

Project Owner
Project Admin