Swipe Match bir müşteri için emlakçı bulur ve lead'i emlakçılara sırayla teklif eder. API üzerinden ortak bir emlakçı (veya ajans) kendisine teklif edilen ve atanan lead'leri görür ve müşteriyle attığı adımları bildirir. Okuma leads:read, olaylar leads:write kapsamını gerektirir. Ücretlendirilmez.
Lead'ler
curl "https://developers.grem.capital/api/v1/match/leads?view=active&limit=20" \
-H "Authorization: Bearer gsk_live_xxx"
GET /match/leads:
| Parametre | Açıklama |
|---|---|
view | active (varsayılan): size atanan lead'ler; inbox: size açık teklifler. Ajans anahtarı, ajans temsilcilerinin lead'lerini ve tekliflerini görür |
stage | aşama filtresi |
page, limit | sayfa; limit en fazla 50, varsayılan 20; 1'den küçük limit veya page, 50'den büyük limit veya 1000'den büyük page: 400 |
GET /match/leads/{id}: tek bir lead; GET /match/leads/{id}/events: geçmişi (sizin olaylarınız ve teklifler; para veya hizmet olayları ve müşteri puanları yok). Başkasına ait lead 404.
Swipe Match hesabınızda API erişimine açılana kadar bu istekler code: not_available ile 409 döndürür.
Lead alanları:
| Alan | Açıklama |
|---|---|
id, stage | kimlik ve aşama |
clientType | buyer veya seller |
country, objectId, objectIds | ülke ve talebin ilgili olduğu ilanlar |
budget | min, max, currency |
answers | müşterinin yanıtları: budget, timeline, payment |
qualScore, qualBand | lead kalite puanı |
clientInitial | müşteri adının ilk harfi |
offer | açık teklifiniz: id, wave, offeredAt, deadline |
contactDeadline, meetingDeadline | iletişim ve görüşme için son tarih |
deal, reservation, dealObjects | işlem ve rezervasyon verileri |
client | müşterinin name ve phone bilgisi: yalnızca lead size atandıktan ve iletişim bilgisi açıldıktan sonra |
brokerId | görünümü gösterilen emlakçı |
fee | bu lead için platform ücreti: none, percent (aldığınız komisyonun bu yüzdesi, percent içinde) veya contract (sözleşmeye göre); asla tutar içermez |
Aşamalar (stage): new, offered, intro, match, contact, meeting_scheduled, meeting_held, contract, deal, closed, lost.
Bir lead ile adımlarınız
POST /match/leads/{id}/events: yalnızca size atanan bir lead için. Modül, adımın mevcut aşamada izinli olup olmadığını denetler.
event | Alanlar | Anlamı |
|---|---|---|
FIRST_CONTACT | channel: phone (varsayılan) veya messenger | müşteriye ulaştınız |
RESERVATION | amount, currency (3 harf), date; documentFileId, isteğe bağlı | müşteri bir rezervasyon ödedi |
STAGE_ROLLBACK | reasonCode: client_withdrew, seller_withdrew, financing_failed, documents, other; text, 500'e kadar | lead'i bir aşama geri alma |
LEAD_LOST | reasonCode: client_refused, client_unreachable, bought_elsewhere, not_target, other; text. Başka bir neden: 400 | lead kaybedildi |
DEAL_CLOSED | objectId, amount, currency, date, documentFileId; commissionReceived, commissionCurrency, isteğe bağlı | işlem kapandı |
documentFileId: POST /uploads ile yüklenmiş bir dosyanın kimliği (Dosyalar). Listesi dışındaki bir reasonCode: 400; LEAD_LOST için other ile text zorunludur (olmadan 400); STAGE_ROLLBACK için text yalnızca other ile saklanır.
curl -X POST https://developers.grem.capital/api/v1/match/leads/LEAD_ID/events \
-H "Authorization: Bearer gsk_live_xxx" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: fc-LEAD_ID-1" \
-d '{"event":"FIRST_CONTACT","channel":"phone"}'
Yanıt: lead, geçişten sonraki lead; replay: true, aynı Idempotency-Key ile yapılmış bir tekrarsa. Müşteri adımları API üzerinden gönderilmez. Buradaki Idempotency-Key 8-128 karakterdir: harfler, rakamlar, _ . : -; başka bir biçim 400 validation verir.
Retler title: business_rule ve nedeni code içinde olacak şekilde 409 olarak gelir:
| Neden | code |
|---|---|
| adım mevcut aşamada kullanılamaz | invalid_transition |
| bir müşteri olayı, emlakçılar bunu göndermez | client_event_rejected |
| modül henüz API'ye açık değil | not_available |
Olaylar
match.lead.offered, match.lead.offer_closed, match.lead.matched, match.lead.updated, match.lead.unassigned: bkz. Webhook'lar. Olaylar asla müşterinin iletişim bilgilerini içermez.
İlgili makaleler
- Lead'ler: CRM'iniz.
- Webhook'lar