09966221721

خانهمستنداتراهنمای وب‌سرویس ثبت لید

راهنمای وب‌سرویس ثبت لید

View Categories

راهنمای وب‌سرویس ثبت لید

Table of Contents

از طریق این وب‌سرویس می‌توانید به‌صورت مستقیم از سایت، فرم‌ها یا سایر سرویس‌های خود، لیدها را در کانکت ثبت کنید.

🔹 آدرس API #

POST /api/v1/leads

🔹 توضیح کلی
با استفاده از این متد، شما می‌توانید اطلاعات لید را به‌صورت مستقیم از هر منبعی (فرم تماس، ثبت‌نام، خرید و …) به سیستم CRM ارسال کنید.
ساختار درخواست شامل هدرها (Headers) و بدنه درخواست (Body) است که در ادامه توضیح داده می‌شود.

🧩 Headers مورد نیاز

کلیدمقدار نمونهتوضیح
Acceptapplication/jsonمقدار ثابت برای تعیین فرمت پاسخ
X-Tenant2شناسه (ID) پنل شما در سیستم CRM، قابل مشاهده از مسیر:
تنظیمات → افزونه‌ها و اتصالات → فیلد «شناسه پنل»
X-Api-Key4WWwrdfdfD4wjf5oh0OZ39IJ5OERhpVDHwBdfdxKXnnIXGoozUDHu7X7Mکلید اختصاصی API برای هر پنل، از مسیر:
تنظیمات → افزونه‌ها → فیلد «API KEY»

🧾 Body (پارامترهای درخواستی)

درخواست باید به‌صورت JSON ارسال شود.

فیلدهای اصلی #

فیلدنوعاجباریتوضیح
phonestring✅ بلهشماره موبایل لید. باید با فرمت استاندارد کشور مقصد ارسال شود (برای ایران به‌صورت پیش‌فرض در نظر گرفته می‌شود).
country_phone_number_codestring❌ خیرکد تلفن کشور (مثلاً 98 برای ایران، 971 برای امارات و …).
country_iso_alpha3_codestring❌ خیرکد سه‌حرفی کشور طبق استاندارد ISO-3166-1 alpha-3 (مثلاً IRN برای ایران، ARE برای امارات، TUR برای ترکیه).
input_channel_codestring❌ توصیه‌شدهکد کانال ورودی که از بخش «مدیریت لید → کانال‌های ورودی» دریافت می‌شود.
در صورت عدم ارسال، سیستم به‌صورت پیش‌فرض مقدار direct را ثبت می‌کند.
landing_codestring❌ خیردر صورت تمایل به ثبت لندینگ مرتبط با این لید، می‌توانید کد لندینگ را از بخش «تنظیمات → لندینگ‌ها» وارد کنید.
submission_page_urlstring❌ خیرآدرس صفحه‌ای که لید از آن ارسال شده (اختیاری اما کاربردی برای تحلیل منابع).
utm_sourcestring❌ خیرمنبع کمپین (مثلاً google, instagram).
utm_mediumstring❌ خیرنوع رسانه (مثلاً cpc, organic, email).
utm_campaignstring❌ خیرنام کمپین بازاریابی.
genderint❌ خیرجنسیت (1 مرد, 0 زن، یا خالی).
first_namestring❌ خیرنام کوچک لید.
last_namestring❌ خیرنام خانوادگی لید.
full_namestring❌ خیرنام کامل لید. بهتر است نام و نام خانوادگی جداگانه ارسال شود
birth_datestring❌ خیرتاریخ تولد لید به فرمت YYYY-MM-DD.
marital_statusstring❌ خیروضعیت تأهل (single, married و غیره).
jobstring❌ خیرشغل لید.
productsarray❌ خیرلیستی از محصولات مورد نظر لید. شامل فیلدهای زیر است:
– origin_id (شناسه محصول)
– quantity (تعداد)
last_chat_atstring❌ خیرتاریخ آخرین گفت‌وگو با لید، در صورت وجود (فرمت YYYY-MM-DD HH:mm:ss).

📤 نمونه درخواست (Sample Request)

POST https://yourdomain.com/api/v1/leads
Content-Type: application/json
Accept: application/json
X-Tenant: 2
X-Api-Key: 4WWwrD4wdfOERhpVDHwBxKXnnIXGoozUDHu7X7M

{
  "phone": "9123456789",
  "country_phone_number_code": "98",
  "country_iso_alpha3_code": "IRN",
  "input_channel_code": "instagram",
  "landing_code": "landing001",
  "submission_page_url": "https://example.com/landing",
  "utm_source": "google",
  "utm_medium": "cpc",
  "utm_campaign": "autumn-sale",
  "gender": "male",
  "first_name": "علی",
  "last_name": "رضایی",
  "full_name": "علی رضایی",
  "birth_date": "1990-05-12",
  "marital_status": "single",
  "job": "developer",
  "products": [
    {
      "origin_id": "101",
      "quantity": "1"
    }
  ],
  "last_chat_at": "2025-10-20 14:32:00"
}

📩 پاسخ (Response)

در صورت موفقیت، پاسخ به‌شکل زیر خواهد بود:


{
    "data": 
        {
            "phone": 
            "+989966221721",
            "updated_at": 
            "2025-11-01T05:58:12.000000Z"
        },
    "message": "لید ثبت شد.",
    "errors": null
}

در صورت خطا (مثلاً شماره تکراری یا پارامتر اشتباه):






{
  "success": false,
  "message": "Phone number already exists"
}






	

	
What are your Feelings
	





 
		
 
	




	


	            
            




        

			
			

                
            

                            

                    

				
                    
						رایگان شروع کنید