مستندات API تماس
این API برای ثبت اطلاعات تماس‌های مربوط به یک پروژه خاص طراحی شده است.
این نقطه دسترسی برای ثبت یک تماس جدید در سیستم استفاده می‌شود. اطلاعات تماس به‌طور کامل بررسی و ذخیره می‌شوند.
و به صورت آنی در صفحه پروژه نشان داده می شوند.
آدرس و متد
آدرس
https://api.hamkar.co/api/voip/
متد
POST
هدرها (Headres)
هدرهای مورد نیاز
- X-API-Key: کلید caller id منحصربه‌فرد شما برای احراز هویت.
نکته: برای دسترسی به این کلید در پنل پروژه به بخش اتصال مراجعه کنید.
درخواست
پارامترها
بدنه درخواست باید یک شیء JSON شامل مقادیر زیر باشد:
- phone (رشته، اجباری): شماره تلفن مرتبط با تماس. فقط اعداد معتبر هستند.
- call_date (رشته، اجباری): تاریخ و زمان تماس به فرمت ISO8601.
- call_type (رشته، اختیاری): نوع تماس.
- مقادیر مجاز:
- “I”: ورودی
- “O”: خروجی
- call_status (رشته، اختیاری): وضعیت تماس.
- مقادیر مجاز:
- “N”: پاسخ داده نشده
- “A”: پاسخ داده شده
- “B”: مشغول
نمونه
{
“phone”: “09123456789”,
“call_date”: “2024-11-25T15:30:00”,
“call_type”: “I”,
“call_status”: “A”
}
پاسخ
پاسخ موفقیت‌آمیز (201 Created)
در صورت موفقیت، یک شیء JSON شامل پیام تأیید بازگردانده می‌شود.
نمونه پاسخ:
{
“detail”: “تماس با موفقیت ثبت شد”
}
خطاها
- 400 Bad Request: پارامترهای درخواست نامعتبر یا ناقص هستند.
- 401 Unauthorized: کلید API معتبر نیست یا ارسال نشده است.
- 403 Forbidden: پروژه غیرفعال یا به دلیل طرح منقضی شده مسدود شده است.
- 429 Too Many Requests: تعداد درخواست‌ها بیش از حد مجاز است؛ لطفاً بعداً تلاش کنید.
- 500 Internal Server Error: خطای غیرمنتظره در سرور رخ داده است.
