وفاوا

اتصال API

وفاوا را به CRM و سیستم داخلی خود وصل کنید

با REST API می‌توانید کمپین‌ها را مدیریت کنید، مخاطب اضافه کنید و سرویس‌ها را فعال کنید — بدون ورود دستی به پنل.

کاربردها

چه کاری با API می‌توانید انجام دهید؟

همگام‌سازی با CRM

مخاطبین جدید CRM را خودکار به کمپین تماس اضافه کنید — بدون آپلود دستی اکسل.

تماس پس از خرید

بعد از ثبت سفارش در فروشگاه، شماره مشتری را به کمپین happy-call یا پیگیری ارسال کنید.

فعال‌سازی سرویس

سرویس تبریک تولد، اطلاع‌رسانی یا نظرسنجی را از سیستم داخلی خود فعال و به‌روز کنید.

مدیریت کیف پول

موجودی و تراکنش‌ها را از backend خود بررسی کنید و در صورت نیاز شارژ انجام دهید.

احراز هویت Bearer

توکن اختصاصی با پیشوند csk_ — فقط روی سرور نگه دارید.

REST + JSON

۱۴ endpoint استاندارد برای پروفایل، کمپین، سرویس و کیف پول.

مرجع

endpointهای موجود

همه درخواست‌ها با هدر Authorization: Bearer csk_... ارسال می‌شوند.

متدمسیرتوضیح
GET/api/v1/users/meپروفایل کاربر
PATCH/api/v1/users/meویرایش پروفایل
GET/api/v1/users/me/integrationsتنظیمات اتصال (smsToken، ترانک، بله) — مقادیر مخفی
PATCH/api/v1/users/me/integrationsذخیره اتصال سرویس‌ها و همگام‌سازی قالب‌های ops
GET/api/v1/campaignsلیست کمپین‌ها
GET/api/v1/campaigns/{id}جزئیات کمپین
PATCH/api/v1/campaigns/{id}ویرایش کمپین
DELETE/api/v1/campaigns/{id}حذف کمپین
POST/api/v1/campaigns/{id}/toggleتوقف / از سرگیری
POST/api/v1/campaigns/{id}/contactsافزودن مخاطب (سیستمی)
POST/api/v1/services/activateفعال‌سازی یا به‌روزرسانی سرویس
GET/api/v1/wallet/meموجودی کیف پول
GET/api/v1/wallet/transactions?take=20&skip=0تراکنش‌های کیف پول
POST/api/v1/wallet/chargeشارژ کیف پول (محدود در production)

مستندات کامل با نمونه curl و مدیریت توکن در پنل کاربری در دسترس است.

نمونه

افزودن مخاطب به کمپین

پرکاربردترین endpoint — بعد از خرید یا ثبت‌نام، مخاطب را مستقیم به کمپین اضافه کنید.

POST/api/v1/campaigns/CAMPAIGN_ID/contacts
curl -X POST 'http://localhost:3000/api/v1/campaigns/CAMPAIGN_ID/contacts' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'
  -d '{ "contacts": [ { "phone": "09121234567", "name": "علی" }, { "phone": "09129876543", "name": "مریم" } ]}'

شروع کار

در ۳ گام به API متصل شوید

  1. 1

    ثبت‌نام رایگان

    حساب کاربری بسازید و شارژ هدیه دریافت کنید.

  2. 2

    ورود به پنل

    از منوی پنل به بخش «اتصال API» بروید.

  3. 3

    دریافت توکن

    توکن API بسازید و در سرور خود استفاده کنید.

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

همین الان ۵۰,۰۰۰ تومان شارژ هدیه بگیرید

ثبت‌نام کنید، شارژ هدیه‌تان فعال می‌شود و می‌توانید یک تماس آزمایشی به شماره خودتان بزنید تا کیفیت را با گوش خودتان بسنجید.

شارژ قابل برداشت نیست ولی برای هر تماس قابل استفاده است · اعتبار هدیه 30 روزه

تماس آزمایشی رایگانحرف می‌زنم با مشاورتماس مستقیم
WAواتس‌اپتلگرامتماس مستقیم