BeeCRM Hujjatlar

Lid yuborish

POST /api/integrations/v1/leads/ — yangi murojaatni BeeCRM'ga yuborish.

So'rov

curl -X POST https://api.beecrm.uz/api/integrations/v1/leads/ \
  -H "Authorization: Bearer $BEECRM_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "event_id": "tg:update:1001",
    "external_contact_id": "telegram:42",
    "first_name": "Ali",
    "phone": "+998901234567",
    "notes": "Kursga yozilmoqchi",
    "metadata": {"source_key": "instagram_reels"}
  }'

Maydonlar

MaydonMajburiyIzoh
event_idhaShu hodisaning o'zgarmas identifikatori. Takror yuborishda aynan shu qiymat.
external_contact_idyo'q, lekin tavsiya etiladiSizdagi odamning doimiy identifikatori. Javoblar shu orqali topiladi.
first_namehaIsm.
last_nameyo'qFamiliya.
phoneyo'qO'zbekiston raqami: +998901234567, 998901234567 yoki 901234567.
emailyo'qElektron pochta.
notesyo'qOperator ko'radigan izoh.
metadatayo'qQo'shimcha ma'lumot, 16 KB gacha. source_key — reklama yoki havola kodi.
answersyo'qShu zahoti ma'lum javoblar, Javoblar sahifasidagidek.

Telefon raqami

BeeCRM raqamni oxirgi 9 raqamga keltiradi. Boshqa davlat raqami shu sababli buziladi: uni notes yoki metadata ichida yuboring.

Bosqich, mas'ul xodim va teglarni yubormang: ular BeeCRM'dagi ulanish sozlamasidan olinadi. metadata.source_key bo'yicha manba va taklif qilgan odam ham BeeCRM'da sozlanadi.

Javob

  • 201 — yangi lid yaratildi.
  • 200 — odam BeeCRM'da allaqachon bor edi va murojaat uning lidiga qo'shildi, yoki bu takroriy so'rov (replayed: true).
{
  "lead": {"id": "6f1c…", "stage": "…", "created_at": "…"},
  "replayed": false,
  "matched_existing": false,
  "contact_id": "a03e…",
  "submission_id": "9b2d…"
}

Takror yuborish

Tarmoq uzilsa yoki 5xx/429 kelsa, o'sha so'rovni o'sha event_id bilan qayta yuboring. BeeCRM uni tanib, ikkinchi lid yaratmaydi va replayed: true qaytaradi. Javobdagi lid ma'lumoti uning hozirgi holatini ko'rsatadi: operator lidni boshqa bosqichga o'tkazgan bo'lsa, bosqich boshqacha bo'ladi, lid o'chirilgan bo'lsa lead: null va deleted: true. Bir xil event_id boshqa ma'lumot bilan kelsa — 409: har bir yangi hodisaga yangi event_id bering.

Ushbu sahifada