Status200
Ресурс

Incoming Call Log

Parent log for each incoming call instance. Groups all escalation attempts together.

Модель Incoming Call Log

Свойства

  • Имя
    _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 Incoming Call Policy

  • Имя
    incomingCallPolicyId
    Тип
    Object IDОбязательно
    Описание

    ID of the Incoming Call Policy

  • Имя
    callerPhoneNumber
    Тип
    Phone
    Описание

    Incoming caller's phone number

  • Имя
    routingPhoneNumber
    Тип
    Phone
    Описание

    The routing number that was called

  • Имя
    callProviderCallId
    Тип
    Text
    Описание

    Call provider's call identifier

  • Имя
    status
    Тип
    TextОбязательно
    Описание

    Current status of the incoming call

  • Имя
    statusMessage
    Тип
    Long Text
    Описание

    Additional status information

  • Имя
    callDurationInSeconds
    Тип
    Number
    Описание

    Total call duration in seconds

  • Имя
    callCostInUSDCents
    Тип
    Number
    Описание

    Total cost for this call in USD cents

  • Имя
    incomingCallCostInUSDCents
    Тип
    Number
    Описание

    Cost for incoming leg in USD cents

  • Имя
    outgoingCallCostInUSDCents
    Тип
    Number
    Описание

    Cost for all forwarding attempts in USD cents

  • Имя
    startedAt
    Тип
    Date
    Описание

    When the call started

  • Имя
    endedAt
    Тип
    Date
    Описание

    When the call ended

  • Имя
    answeredByUser
    Тип
    User
    Описание

    User who answered the call

  • Имя
    answeredByUserId
    Тип
    Object ID
    Описание

    User ID who answered the call

  • Имя
    currentEscalationRuleOrder
    Тип
    Number
    Описание

    The current escalation rule order being processed

  • Имя
    repeatCount
    Тип
    Number
    Описание

    Number of times the policy has been repeated

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

Список

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

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

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

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

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

POST
/api/incoming-call-log/get-list?skip=0&limit=10
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "incomingCallPolicyId": true,
    "projectId": true,
    "status": true,
    "_id": true,
    "answeredByUser": true
  },
  "query": {
    "status": "Example status"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "37733f60-28fe-11f1-b591-3fdcef396aba",
      "incomingCallPolicyId": "550e8400-e29b-41d4-a716-446655440000",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "status": "Example status",
      "answeredByUser": "Example answered by user"
    },
    {
      "_id": "37733f61-28fe-11f1-b591-3fdcef396aba",
      "incomingCallPolicyId": "550e8400-e29b-41d4-a716-446655440000",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "status": "Example status",
      "answeredByUser": "Example answered by user"
    },
    {
      "_id": "37733f62-28fe-11f1-b591-3fdcef396aba",
      "incomingCallPolicyId": "550e8400-e29b-41d4-a716-446655440000",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "status": "Example status",
      "answeredByUser": "Example answered by user"
    }
  ]
}
GETorPOST/api/incoming-call-log/:id/get-item

Получить по ID

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

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

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

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

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

POST
/api/incoming-call-log/:id/get-item
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "incomingCallPolicyId": true,
    "projectId": true,
    "status": true,
    "_id": true,
    "answeredByUser": true
  }
}

Ответ

{
  "_id": "550e8400-e29b-41d4-a716-446655440000",
  "incomingCallPolicyId": "550e8400-e29b-41d4-a716-446655440000",
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "Example status",
  "answeredByUser": "Example answered by user"
}
POST/api/incoming-call-log/count

Количество

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

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

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

POST
/api/incoming-call-log/count
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "query": {
    "status": "Example status"
  }
}

Ответ

{
  "count": 107
}

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

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

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

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

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

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

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

Ресурс нельзя создать через API

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

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

Ресурс нельзя обновить через API

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

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

Ресурс нельзя удалить через API