Заказы на обратный звонок

Обзор

Управляет заказами на обратные звонки, связанные с номером конкретной учетной записи SIP, прикрепленной к авторизованному пользователю.

Ящик заказов имеет тот же номер, что и учетная запись, которой он принадлежит.
Доступ к нему осуществляется компонентом IVR-сценария "Обратный звонок".

Заказы на обратные звонки хранятся в коллекции 'telephony/CallbackRequests'.

Коллекция по полному пути доступна пользователям для подписки на изменения через websocket subscr, а также на операции CRUD через websocket rest.

Запросы

HTTP verb Endpoint Описание

GET

/rest/v1/user/sip/accounts/<AccountID>/callback_requests

Получение списка заказов на обратный звонок

GET

/rest/v1/user/sip/accounts/<AccountID>/callback_requests/<Date>

Получение списка заказов на обратный звонок

GET

/rest/v1/user/sip/accounts/<AccountID>/callback_requests/<Date>/<Id>

Получение сущности конкетного заказа по идентификатору

PATCH

/rest/v1/user/sip/accounts/<AccountID>/callback_requests/<Date>/<Id>

Изменение состояния заказа на обратный вызов

DELETE

/rest/v1/user/sip/accounts/<AccountID>/callback_requests/<Date>/<Id>

Удаление заказа на обратный вызов

Для всех запросов:
Тип домена: рабочий

Получение списка заказов на обратный звонок

Возвращает список всех заказов из ящика учетной записи SIP, указанной с помощью идентификатора и прикрепленной к авторизованному пользователю.

В списке присутствуют все указанные заказы за интервал времени, привязанные к номеру абонента.
Если используется Endpoint с датой, то исходным множеством являются все сообщения за эту дату.
В противном случае необходимо указывать GET-параметр 'interval'.

Запрос

Пример запроса
GET /rest/v1/user/sip/accounts/c7e163c6-8b5e-cb6e-7bf4-441a912ff0b9/callback_requests?interval=["2022-10-21","2022-10-22"]&limit=3 HTTP/1.1

GET /rest/v1/user/sip/accounts/c7e163c6-8b5e-cb6e-7bf4-441a912ff0b9/callback_requests/2022-10-21?limit=3 HTTP/1.1

Ответ

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json

[
  {
    "abonentPhoneNumber": "1234",
    "boxPhoneNumber": "11",
    "dateTime": "2022-10-21T14:00:37.192Z",
    "id": "c534ed44-0183-fad8-8447-7cd30a921f58",
    "status": "new"
  },
  {
    "abonentPhoneNumber": "12",
    "boxPhoneNumber": "11",
    "dateTime": "2022-10-21T11:06:30.081Z",
    "id": "44745728-0183-fa39-1b40-7cd30a921f58",
    "status": "new"
  },
  {
    "abonentPhoneNumber": "13",
    "boxPhoneNumber": "11",
    "dateTime": "2022-10-21T11:06:27.605Z",
    "id": "2a45dccb-0183-fa39-1195-7cd30a921f58",
    "status": "viewed"
  }
]

Получение сущности конкетного заказа по идентификатору

Запрос

Пример запроса
GET /rest/v1/user/sip/accounts/c7e163c6-8b5e-cb6e-7bf4-441a912ff0b9/callback_requests/2022-10-21/c534ed44-0183-fad8-8447-7cd30a921f58 HTTP/1.1

Ответ

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json

{
  "abonentPhoneNumber": "1234",
  "boxPhoneNumber": "11",
  "dateTime": "2022-10-21T14:00:37.192Z",
  "id": "c534ed44-0183-fad8-8447-7cd30a921f58",
  "status": "new"
}

Изменение состояния заказа на обратный вызов

Изменяет статус существующего заказы на обратные вызовы.

Запрос

Пример запроса
PATCH /rest/v1/user/sip/accounts/c7e163c6-8b5e-cb6e-7bf4-441a912ff0b9/callback_requests/2022-10-21/c534ed44-0183-fad8-8447-7cd30a921f58 HTTP/1.1
Content-Type: application/json

{
  "status": "viewed"
}

Ответ

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json

{
  "abonentPhoneNumber": "1234",
  "boxPhoneNumber": "11",
  "dateTime": "2022-10-21T14:00:37.192Z",
  "id": "c534ed44-0183-fad8-8447-7cd30a921f58",
  "status": "viewed"
}

Удаление заказа на обратный вызов

Удаляет указанный заказ на обратный вызов.

Запрос

Пример запроса
DELETE /rest/v1/user/sip/accounts/c7e163c6-8b5e-cb6e-7bf4-441a912ff0b9/callback_requests/2022-10-21/c534ed44-0183-fad8-8447-7cd30a921f58 HTTP/1.1

Ответ

Пример ответа
HTTP/1.1 204 No Content