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

Пошук

api_get_contact

Повертає список клієнтів (контактів), які були відвідані хоча б один раз. Без обмеження за часом.

Запит

Endpoint

POST https://yourdomain.pharmahrm.com/crm-api/db-function/run

Аутентифікація

Bearer Token (обов'язковий)

Структура запиту

Заголовки

Ключ Значення
Authorization Bearer <token>
Content-Type application/json

Тіло запиту

{
  "function": "api_get_contact",
  "format": "csv",
  "arguments": {
    "ids": "1,2,3,4"
  }
}
Поле Тип Обов'язковий Опис
function string Так Ім’я викликаного методу. Для цього запиту — "api_get_contact"
format string Так Формат відповіді - csv
arguments object Ні Необов’язкові аргументи, специфічні для методу
ids string Ні Список ID клієнтів через кому. Якщо не вказано, повертаються всі відвідані клієнти

Успішна відповідь

200 OK

Формат "csv": відповідь у вигляді тексту CSV.

Content-Type

text/plain

Приклад відповіді
contact_name,contact_type,contact_spec,contact_target,contact_categ,contact_categ_by_direction,isarchive,contact_morionid,company_id,company_morionid,contact_email,contact_phone,contact_id
Dr. John Smith,Doctor,Cardiologist,A,VIP,A,No,AXC12345,110,AMX99322,j.smith@example.com,+380501234567,555
Поле Опис
contact_name Повне ім’я клієнта
contact_type Тип клієнта (лікар, фармацевт)
contact_spec Спеціалізація клієнта
contact_target Цільова група/категорія клієнта
contact_categ Загальна категорія клієнта
contact_categ_by_direction Категорія за напрямком продукту
isarchive Прапорець архівації - містить причину архівації
contact_morionid Ідентифікатор клієнта в базі Axioma
conpamy_id ID установи з Proxima CRM (місце роботи)
company_morionid Ідентифікатор установи в БД Axioma (основне місце роботи)
contact_email email клієнта
contact_phone Телефон
contact_id Ідентифікатор клієнта в Proxima CRM

Помилкова відповідь

40x/50x

{
  "message": "string"
}
Код Опис
400-499 Помилка на стороні клієнта
500-599 Помилка на стороні сервера