Перейти к основному содержимому

Консультации

API для работы с консультациями пользователей.

Получение списка консультаций

Возвращает список всех консультаций пользователя.

Endpoint: GET /api/v1/users/consultation/{id}

Параметры URL:

  • id (integer, обязательный) - ID пользователя

Заголовки:

token: YOUR_PARTNER_API_KEY

Пример ответа:

{
"status": "success",
"data": {
"items": [
{
"id": 456,
"status": "completed",
"format": "chat",
"client_user": "Иван Иванов",
"price": 1500,
"client_user_id": 123,
"subject": "Консультация по питанию",
"consultant_user_id": 789,
"conversation_id": "conv_123",
"is_error": 0,
"created_at": 1638360000,
"updated_at": 1638370000
}
]
}
}

Возможные ошибки:

  • 404 - Пользователь не найден или не принадлежит партнеру

Просмотр сообщений консультации

Получение всех сообщений по конкретной консультации.

Endpoint: GET /api/v1/users/consultation-view/{id}

Параметры URL:

  • id (integer, обязательный) - ID консультации

Заголовки:

token: YOUR_PARTNER_API_KEY

Пример ответа:

{
"status": "success",
"data": {
"items": [
{
"id": 1,
"conversation_id": "conv_123",
"user_id": 123,
"type": "text",
"data": "Здравствуйте, у меня вопрос по питанию кота",
"file": null,
"created_at": 1638360000
},
{
"id": 2,
"conversation_id": "conv_123",
"user_id": 789,
"type": "text",
"data": "Здравствуйте! Расскажите подробнее о проблеме",
"file": null,
"created_at": 1638360100
},
{
"id": 3,
"conversation_id": "conv_123",
"user_id": 123,
"type": "file",
"data": "Фото кота",
"file": "https://kotzdorov.ru/files/photo.jpg",
"created_at": 1638360200
}
]
}
}

Возможные ошибки:

  • 404 - Консультация не найдена или не принадлежит партнеру

Получение заключения

Получение заключения врача по консультации.

Endpoint: GET /api/v1/users/consultation-conclusion/{id}

Параметры URL:

  • id (integer, обязательный) - ID консультации

Заголовки:

token: YOUR_PARTNER_API_KEY

Пример ответа:

{
"status": "success",
"data": {
"items": [
{
"id": 10,
"consultation_id": 456,
"path": "https://kotzdorov.ru/conclusions/conclusion_456.pdf",
"type": "conclusion",
"created_at": 1638370000
}
]
}
}

Возможные ошибки:

  • 404 - Консультация не найдена или заключение отсутствует

История звонков

Получение истории звонков пользователя.

Endpoint: GET /api/v1/users/call-history/{id}

Параметры URL:

  • id (integer, обязательный) - ID пользователя

Заголовки:

token: YOUR_PARTNER_API_KEY

Пример ответа:

{
"status": "success",
"data": {
"items": [
{
"id": 100,
"user_id": 123,
"partner_id": 5,
"operator_user_id": 50,
"call_id": "call_abc123",
"direction": "inbound",
"caller": "79001234567",
"duration": 320,
"record": 1,
"record_url": "https://kotzdorov.ru/records/call_abc123.mp3",
"caller_provider": "voximplant",
"status": "completed",
"created_at": 1638360000
}
]
}
}

Возможные ошибки:

  • 404 - Пользователь не найден или не принадлежит партнеру

Структура данных

Объект Consultation

ПолеТипОписание
idintegerID консультации
statusstringСтатус (pending/active/completed/cancelled)
formatstring|nullФормат (chat/video/call)
client_userstring|nullИмя клиента
priceintegerСтоимость консультации
client_user_idintegerID клиента
subjectstring|nullТема консультации
consultant_user_idintegerID консультанта
conversation_idstring|nullID беседы
is_errorinteger|nullФлаг ошибки (0/1)
created_atintegerUnix timestamp создания
updated_atintegerUnix timestamp обновления

Объект Message

ПолеТипОписание
idintegerID сообщения
conversation_idstring|nullID беседы
user_idintegerID отправителя
typestringТип (text/file/image/video)
datastring|nullТекст сообщения или описание файла
filestring|nullURL файла
created_atintegerUnix timestamp создания

Объект CallHistory

ПолеТипОписание
idintegerID записи
user_idintegerID пользователя
partner_idinteger|nullID партнера
operator_user_idinteger|nullID оператора
call_idstringУникальный ID звонка
directionstringНаправление (inbound/outbound)
callerstringНомер звонящего
durationintegerДлительность в секундах
recordintegerНаличие записи (0/1)
record_urlstring|nullURL записи звонка
caller_providerstringПровайдер связи
statusstringСтатус звонка
created_atintegerUnix timestamp создания