پیگیری سفارش
ورود به پنل

مستندات API

هر سوالی یا مسئله ای که در وصل کردن API به سایت خودتان داشتید در قسمت تیکت پشتیبانی و بخش مشکل در برنامه نویسی و API ارسال کنید تا کمک لازمه انجام گیرد.

 

دریافت و مدیریت شماره مجازی از طریق API

از طریق API اختصاصی، امکان مشاهده موجودی شماره‌ها و تعرفه هر کدام فراهم شده است.

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

قیمت‌هایی که در این بخش نمایش داده می‌شود دقیقاً مطابق با قیمت‌های فعال در حساب کاربری شماست. بنابراین اگر تخفیف یا نرخ ویژه‌ای برای حسابتان در نظر گرفته شده باشد، همان شرایط در این سرویس نیز اعمال خواهد شد.

شما می‌توانید سیستم خود را به‌گونه‌ای پیاده‌سازی کنید که به‌صورت خودکار، مبلغ دلخواهی را به قیمت پایه اضافه کرده و شماره را با نرخ نهایی به کاربران خود ارائه دهید.

 

 

ثبت درخواست شماره مجازی

از طریق وب‌سرویس مربوطه (در انتهای صفحه)، امکان ثبت درخواست شماره جدید وجود دارد.

در زمان ثبت درخواست، اطلاعات زیر مشخص می‌شود:

  • سرویس مورد نظر جهت دریافت پیامک

  • کشور شماره مجازی

  • اپراتور مخابراتی (یا انتخاب خودکار اپراتور بر اساس مناسب‌ترین قیمت)

پس از ثبت درخواست، شماره مجازی به همراه جزئیات مورد نیاز در اختیار شما قرار می‌گیرد و هزینه آن از اعتبار حساب شما کسر می‌شود.

نکته مهم:
در صورتی که شماره لغو شود یا پیش از دریافت کد، مهلت آن به پایان برسد، مبلغ پرداخت‌شده به حساب کاربری شما بازگردانده خواهد شد.

 

 

ویژگی‌های هر شماره مجازی

هر شماره دارای ویژگی‌های زیر است:

  • شناسه عددی یکتا: هر شماره دارای یک شناسه عددی یکتا است که در تمام مراحل بعدی مورد استفاده قرار می‌گیرد.

  • زمان مشخص برای دریافت پیامک: هر شماره زمان مشخصی برای دریافت پیامک دارد.

  • امکان دریافت چندین پیامک: در بازه زمانی فعال بودن شماره، امکان دریافت چندین پیامک برای همان سرویس وجود دارد.

  • پایان زمان اعتبار شماره: پس از پایان زمان تعیین‌شده، دریافت کد جدید امکان‌پذیر نخواهد بود.

 

 

بررسی وضعیت شماره

با استفاده از وب‌سرویس بررسی وضعیت، می‌توانید در هر لحظه از وضعیت فعلی شماره مطلع شوید.

وضعیت فعلی شماره ممکن است شامل موارد زیر باشد:

  • در انتظار دریافت کد

  • کد دریافت شده (به‌همراه نمایش کد)

  • اتمام زمان استفاده

  • لغو شده توسط کاربر

  • در انتظار دریافت کد مجدد

 

 

تغییر وضعیت شماره

از طریق وب‌سرویس مدیریت وضعیت، امکان اعمال عملیات زیر وجود دارد:

  • لغو شماره: در صورتی که هنوز کدی دریافت نشده باشد – هزینه برگشت داده می‌شود.

  • اتمام درخواست پس از دریافت موفق کد

  • درخواست کد مجدد: در صورت باقی بودن زمان اعتبار شماره.

پس از اعمال هر تغییر، می‌توانید مجدداً از وب‌سرویس بررسی وضعیت استفاده کرده و از نتیجه عملیات مطلع شوید.

https://panel.arzancell.com/virtualnumber/api?method=getinfo&apikey=[API_CODE]

توضیح پارامترهای لینک

[API_CODE] کلید API دریافت شده از تنظیمات کاربری

پارامترهای اختیاری

می توانید پارامترهای زیر را نیز به لینک اضافه کنید و نتیجه را با ترتیب و فیلترهای مورد نظرتان دریافت کنید.

&operator=[OPERATOR_CODE] کد اپراتور مخابراتی موجود قسمت لیست اپراتورهای مخابراتی
با افزودن این پارامتر فقط اطلاعات شماره های اپراتور مورد نظر نمایش داده میشود
&country=[COUNTRY_CODE] کد کشور موجود در قسمت لیست کشورها
با افزودن این پارامتر فقط اطلاعات شماره های کشور مربوطه نمایش داده می شود
&service=[SERVICE_CODE] کد سرویس موجود در قسمت لیست سرویس ها
با افزودن این پارامتر، فقط اطلاعات شماره های سرویس مورد نظر نمایش داده می شود

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

[ { "service": 2, "country": 10, "operator": 1, "count": 73649, "amount": 1600, "time": 20, "time_cancel": 2, "active": 1 }, { "service": 2, "country": 14, "operator": 1, "count": 6188, "amount": 8000, "time": 20, "time_cancel": 2, "active": 1 } ]

توضیح نتیجه درخواست

service کد سرویس، موجود در قسمت لیست سرویس ها
country کد کشور، موجود در قسمت لیست کشورها
operator کد اپراتور مخابراتی موجود در قسمت لیست اپراتورهای مخابراتی

https://panel.arzancell.com/virtualnumber/api?method=getnum&apikey=[API_CODE]

توضیح پارامترهای لینک

[API_CODE] کلید API دریافت شده از تنظیمات کاربری

پارامترهای اختیاری

می توانید پارامترهای زیر را نیز به لینک اضافه کنید و نتیجه را با ترتیب و فیلترهای مورد نظرتان دریافت کنید.

&operator=[OPERATOR_CODE] کد اپراتور مخابراتی موجود قسمت لیست اپراتورهای مخابراتی
با افزودن این پارامتر فقط اطلاعات شماره های اپراتور مورد نظر نمایش داده میشود
&country=[COUNTRY_CODE] کد کشور موجود در قسمت لیست کشورها
با افزودن این پارامتر فقط اطلاعات شماره های کشور مربوطه نمایش داده می شود
&service=[SERVICE_CODE] کد سرویس موجود در قسمت لیست سرویس ها
با افزودن این پارامتر، فقط اطلاعات شماره های سرویس مورد نظر نمایش داده می شود

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

[ { "RESULT": 1, "ID": 1732282, "NUMBER": "18024740037", "AREACODE": "1", "AMOUNT": 56000 } ]

توضیح نتیجه درخواست

RESULT در صورت موفق بودن عملیات، مقدار 1 می شود
ID آیدی اختصاصی شماره خرید شده (آیدی هر شماره را در دیتا ذخیره کنید، جهت انجام عملیات های بعدی مورد نیاز است)
NUMBER کد اپراتور مخابراتی موجود در قسمت لیست اپراتورهایشماره مجازی خریداری شده به همراه پیش شماره کشور
AREACODE پیش شماره کشور
AMOUNT قیمت شماره خریداری شده به تومان

ایرادهای احتمالی این بخش

در صورتی که مقدار RESULT عدد 1 نباشد خطائی پیش آمده و ممکن است یکی از مقادیر زیر باشد که خطا و توضیح آن را می توانید مشاهده کنید:

RESULT DESCRIPTION توضیـح
-202 parameters not found مقدار یکی از پارامترها خالی و یا اشتباه است
-204 this number is not active شماره مورد نظر فعال نیست
-205 no balance شارژ شما در پنل کم است
-210 service is not active سرویس مورد نظر فعال نیست
-211 operator is not active اپراتور مخابراتی انتخابی فعال نیست
-212 country is not active کشور انتخابی فعال نیست
ایراد های دیگر که در خود اپراتور ها اتفاق می افتد مشکلی در اپراتور است که فعلا امکان انجام این فعالیت را ندارد باید صبر کنید و بعدا دوباره اقدام نمایید

https://panel.arzancell.com/virtualnumber/api?method=checkstatus&apikey=[API_CODE]&id=[ID]

توضیح پارامترهای لینک

[API_CODE] کلید API دریافت شده از تنظیمات کاربری
[ID] همان آی دی شماره مجازی که هنگام خرید شماره دریافت کردید

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

[ { "RESULT":1, "CODE":"0", "DESCRIPTION":"wait code" } ]

توضیح نتیجه درخواست

RESULT DESCRIPTION توضیـح
1 wait code در انتظار دریافت کد
2 code received در این حالت کد دریافت شده و در این مقدار نمایش داده میشود
3 number canceled شماره کنسل شده است
4 number banned شماره مسدود شده است
5 wait code again در انتظار دریافت کد مجدد
6 completed تکمیل درخواست

ایرادهای احتمالی این بخش

RESULT DESCRIPTION توضیـح
-304 number id not fount آیدی شماره یافت نشد

https://panel.arzancell.com/virtualnumber/api?apikey=[API_CODE]&method=[METHOD_NAME]&id=[ID]

توضیح پارامترهای لینک

[API_CODE] کلید API دریافت شده از تنظیمات کاربری
ID همان آی دی شماره مجازی که هنگام خرید شماره دریافت کردید

توضیح پارامترهای method

[METHOD_NAME] توضیح
cancelnumber کنسل کردن شماره؛ تنها زمانی می توانید شماره را کنسل کنید که در وضعیت1 (در انتظار دریافت کد) باشد. در صورت موفق بودن عملیات، هزینه شماره به حساب شما در پنل برگشت میخورد
bannumber اعلان مسدودی شماره؛ تنها زمانی می توانید شماره را کنسل کنید که در وضعیت1 (در انتظار دریافت کد) باشد. در صورت موفق بودن عملیات، هزینه شماره به حساب شما در پنل برگشت میخورد
repeat گرفتن کد مجدد؛ در صورتی می توانید درخواست کد مجدد بدهید که شماره در وضعیت 2 (دریافت موفق کد) باشد در صورت موفقیت آمیز بودن درخواست، وضعیت شماره به 5 (در انتظار دریافت کد مجدد) تغییر می کند
closenumber تکمیل درخواست و بستن شماره؛ در صورتی که کد را دریافت کردید و درخواست دیگری برای دریافت کد مجدد در تایم باقی مانده ندارید. این دستور فقط در حالتی عمل می کند که شماره در وضعیت 2 (دریافت موفق کد) یا وضعیت 5 (در انتظار دریافت کد مجدد) باشد. در صورت موفق آمیز بودن دستور، وضعیت شماره به 6 (تکمیل درخواست) تغییر می کند

https://panel.arzancell.com/virtualnumber/api?method=getcountry&apikey=[API_CODE]

توضیح پارامترهای لینک

[API_CODE] کلید API دریافت شده از تنظیمات کاربری

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

[ { "id": "1", "name": "روسیه", "name_en": "Russia", "areacode": "7", "emoji": "🇷🇺", "image": "/images/cu/ru.png", "active": "1" }, { "id": "2", "name": "اکراین", "name_en": "Ukraine", "areacode": "380", "emoji": "🇺🇦", "image": "/images/cu/ua.png", "active": "1" } ]

توضیح نتیجه درخواست

ID آیدی اختصاصی کشور (همیشه ثابت است)
name نام فارسی کشور
name_en نام انگلیسی کشور
areacode پیش شماره کشور
emoji کاراکتر ایموجی پرچم کشور
image پرچم
active فعال یا غیر فعال بودن کشور، در صورت فعال بود وضعیت 1 است

https://panel.arzancell.com/virtualnumber/api?method=getservice&apikey=[API_CODE]

توضیح پارامترهای لینک

[API_CODE] کلید API دریافت شده از تنظیمات کاربری

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

[ { "id":"2", "name":"اینستاگرام", "name_en":"Instagram", "description":"", "image":"/images/sv/instagram.svg", "active":"1" } ]

توضیح نتیجه درخواست

ID آیدی اختصاصی سرویس (همیشه ثابت است)
name نام فارسی سرویس
name_en نام انگلیسی سرویس
description توضیحات این سرویس
image تصویر سرویس
active فعال یا غیر فعال بودن سرویس، در صورت فعال بود وضعیت 1 است.

https://panel.arzancell.com/virtualnumber/api?method=getoperator&apikey=[API_CODE]

توضیح پارامترهای لینک

[API_CODE] کلید API دریافت شده از تنظیمات کاربری

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

[ { "operator": 2, "name": "سرور 2" }, { "operator": 3, "name": "سرور 3" } ]

توضیح نتیجه درخواست

کد اپراتور توضیح
1 اپراتور مشخص شده در شماره های داخل پنل با عدد 1
2 اپراتور مشخص شده در شماره های داخل پنل با عدد 2
3 اپراتور مشخص شده در شماره های داخل پنل با عدد 3
4 اپراتور مشخص شده در شماره های داخل پنل با عدد 4
min در این حالت ارزان ترین شماره در میان اپراتورها به صورت اتوماتیک انتخاب می شود در صورت عدم موجودی شماره گرانتر انتخاب نمی شود. مثلا در صورتی که درخواست شماره تلگرام از روسیه را بدهید، سیستم روسیه 2 را برای شما انتخاب می کند، حال چه موجودی شماره داشته باشد یا موجودی آن صفر باشد. اما مثلا از یک سرویس یا کشور دیگر درخواست شماره بدهید ممکن است بنا به درخواست شما اپراتور دیگری انتخاب شود
any این گزینه همانند مورد بالا عمل می کند با این تفاوت که در صورت عدم موجودی شماره،اپراتور دیگری را به صورت اتوماتیک برای شما انتخاب می کند که موجودی شماره داشته باشد. ترتیب از قیمت کم به زیاد می باشد

https://panel.arzancell.com/virtualnumber/api?method=balance&apikey=[API_CODE]

توضیح پارامترهای لینک

[API_CODE] کلید API دریافت شده از تنظیمات کاربری

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

[ { "RESULT":"1", "BALANCE":"192100", "CURRENCY":"Toman" } ]
RESULT DESCRIPTION توضیـح
-901 apikey not found کلید api اشتباه است
-902 method invalid دستور ارسالی اشتباه است
-990 number id invalid آی دی شماره مورد نظر اشتباه است
-900 دیگر ایرادات فنی - با پشتیبانی تماس بگیرید و مستندات خطا را ارائه دهید