Skip to content

Latest commit

 

History

History
96 lines (69 loc) · 3.62 KB

callbacks.md

File metadata and controls

96 lines (69 loc) · 3.62 KB

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

Запуск консультации

POST /api/v1/callbackrequest/start-callback вернёт информацию о запущенной консультации.

Запрос:

Имя Тип Описание
doctorId integer уникальный идентификатор врача
patientPhone object телефонный номер пациента (объект телефон). Пример: {code: "1", number: "1111111111"}
patientFullName string фио пациента
beginAtUtc datetime (optional) время начала консультации. Если параметр не указан, то консультация начнется сразу.
duration integer (optional) максимальная длительность консультации в минутах.
attachment file (optional) информация с информацией о пациенте (может послужить предметом обсуждения во время консультации). Содержимое multipart/form-data. Максимальный размер вложения 10 МБ.
externalNotificationUrl string (optional) web-hook URL. По этому адресу будет отправлен GET-запрос без каких-либо дополнительных параметров, если был изменен статус консультации. Например, было добавлено заключение, и статус консультации был изменен на "Завершено".

Ответ:

Объект Обратный звонок

{
  //.. объект обратный звонок
}

Получение информации о консультации

GET /api/v1/callbackrequest/get/{id} вернёт информацию о консультации.

Запрос

Имя Тип Описание
id string уникальный идентификатор консультации вида обратный звонок

Ответ

Объект Обратный звонок

{
  //.. объект обратный звонок
}

Поиск по консультациям

GET /api/v1/callbackrequest/get-all вернёт список консультаций.

Запрос

Имя Тип Описание
ids array уникальные идентификаторы консультации вида обратный звонок
statuses array<Request Status> статусы консультации
order string сортировать по полю (Created, Status)
asc boolean сортировать по возрастанию
limit integer кол-во (записей в ответе)
offset integer смещение (сколько записей пропустить)

Ответ

Объект Обратный звонок

{
  "items": [
    {
      //.. объект обратный звонок
    }
  ],
  "count": 10,
  "totalCount": 10
}

Прерывание консультации

POST /api/v1/callbackrequest/terminate-callback вернёт информацию о результате прерывания.

Запрос

Имя Тип Описание
requestId string уникальный идентификатор консультации вида обратный звонок

Ответ

{
  "success": true
}