API & Webhook

وب‌سرویس ویپانو برای اتصال سریع

به تماس، صف، گزارش CDR و وبهوک‌های لحظه‌ای دسترسی بگیرید. با توکن امن و ساختار REST به‌سادگی متصل شوید.

مسیرها نمونه درخواست

Base URL https://voipano.ir/api/v1

همه مسیرها از این آدرس شروع می‌شوند.

Authorization Bearer YOUR_TOKEN

هدر اجباری برای تمام درخواست‌ها

هویت و امنیت

شروع سریع

توکن دسترسی

توکن را از پنل کاربری بخش وب‌سرویس دریافت کنید. همه درخواست‌ها باید با هدر زیر ارسال شوند:

Authorization: Bearer YOUR_TOKEN

Content-Type: application/json

پایه

آدرس پایه

https://voipano.ir/api/v1

نسخه فعلی v1 است؛ برای آپدیت نسخه جدید از changelog مطلع شوید.

مسیرهای اصلی

API Endpoints

پوشش تماس، شماره، صندوق صوتی و وبهوک‌های تماس.

GET /api/v1/calls

گزارش تماس‌ها

دریافت لیست تماس‌ها با فیلتر تاریخ، شماره و وضعیت

GET /api/v1/services

سرویس‌ها و شارژ خطوط

لیست سرویس‌های فعال، وضعیت و اعتبار خط

GET /api/v1/cities

لیست شهرها

دریافت شهرهای ثبت‌شده برای مسیریابی/شماره‌ها

GET /api/v1/time

تاریخ و ساعت سرور

زمان سرور در فرمت‌های مختلف (ISO, Unix, Jalali)

GET /api/v1/voicemail

صندوق صوتی

لیست فایل‌های صندوق صوتی

GET /api/v1/calls/{id}/record

دریافت صوت مکالمه

دانلود فایل ضبط‌شده تماس

GET /api/v1/calls/{id}

گزارش تماس تکی

دریافت جزئیات یک تماس با شناسه یکتا

POST /api/v1/click-to-call

تماس سریع (Click To Call)

شروع تماس بین دو شماره با یک درخواست

GET /api/v1/voicemail/{id}/file

دریافت فایل صندوق صوتی

دانلود صوت صندوق صوتی

POST /webhook/cdr

Webhook CDR

ارسال جزئیات تماس پس از پایان مکالمه

POST /webhook/call-events

Webhook ایونت تماس

ارسال ایونت Ringing/Hangup و تغییر وضعیت تماس

نمونه درخواست

Call Logs

GET https://voipano.ir/api/v1/calls?from=2024-01-01&to=2024-01-31

curl -X GET "https://voipano.ir/api/v1/calls?from=2024-01-01&to=2024-01-31" \
-H "Authorization: Bearer YOUR_TOKEN"

پاسخ نمونه:

{
  "data": [
    {
      "id": "call_123",
      "from": "02191001234",
      "to": "09351234567",
      "direction": "inbound",
      "duration": 42,
      "status": "answered",
      "started_at": "2024-01-10T12:34:00Z"
    }
  ],
  "meta": {"total": 120, "page": 1, "per_page": 20}
}

وبهوک‌ها

رویدادهای تماس

ارسال ایونت با HMAC در هدر X-Voipano-Signature.

مسیر	شرح	Payload
POST /webhook/cdr	ارسال CDR پس از پایان تماس	id, from, to, duration, status, started_at, ended_at
POST /webhook/call-events	ایونت Ringing / Hangup	event, call_id, from, to, timestamp

برای تنظیم آدرس وبهوک و توکن HMAC به بخش «خدمات وب‌سرویس» در پنل کاربری مراجعه کنید.