شروع کار

API یک راه ارتباطی بین نرم افزار و وبسایت شما با سرور ما می باشد
جهت دریافت اس ام اس نیاز به فرایند اتوماسیون از طرف شما می باشد، بنابراین مستندات را به خوبی مطالعه نموده و از آن استفاده نمایید
کلید API شما
You must signup to get api key      تغییر کلید api
API ما کاملا سازگار با سایت های رقیب است
تمام درخواست ها باید به آدرس http://arzancell.com/api/handler.php ارسال گردند
تنها درخواست های GET قابل پذیرش می باشند
تمامی درخواست ها شامل دو بخش اصلی کلید API و action میباشند

مشاهده موجودی حساب

#curl
#نمونه درخواست مشاهده موجودی حساب

curl \
-X GET http://arzancell.com/api/handler.php \
-F 'api=your_api_key' \
-F 'action=get_balance' 
                

#json
#نمونه خروجی

[
  {
    "balance": 981000,
    "unit": "Toman"
  }
]
                

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

نام پارامتر	نوع پارامتر	توضیحات
api	String	کلید API شما
action	String	get_balance

خروجی

نام خروجی	توضیحات
balance	موجودی حساب شما
unit	واحد پول موجودی شما

مشاهده شماره های موجود

#curl
#نمونه درخواست دریافت شماره های موجود

curl \
-X GET http://arzancell.com/api/handler.php \
-F 'api=your_api_key' \
-F 'action=get_status' \
-F 'server=server_number' \
-F 'country=country_code' 
                

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

#json
# نمونه خروجی

[
    {
    "server":"3",
    "service name":"viber",
    "service code":"viber",
    "country":"ee",
    "stock":"0",
    "price":2800
    },
    {
    "server":"3",
    "service name":"whatsapp",
    "service code":"whatsapp",
    "country":"ee",
    "stock":"1400",
    "price":5600
    },
    {"server":"3",
    "service name":"telegram",
    "service code":"telegram",
    "country":"ee",
    "stock":"3",
    "price":8400
    }
]
                

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

نام پارامتر	نوع پارامتر	توضیحات
api	String	کلید API شما
action	String	get_status
server	String	شماره سرور یا برای انتخاب تمام سرور ها از عبارت any استفاده کنید
country	String	کد کشور یا برای انتخاب تمام کشور ها از عبارت any استفاده کنید

خروجی

نام خروجی	توضیحات
server	شماره سرور
service_name	نام سرویس
service_code	کد سرویس جهت استفاده در مراحل بعدی
country	کد کشور
stock	تعداد شماره های موجود
price	هزینه شماره

دریافت شماره

#curl
#نمونه درخواست دریافت شماره

curl \
-X GET http://arzancell.com/api/handler.php \
-F 'api=your_api_key' \
-F 'action=get_number' \
-F 'server=server_number' \
-F 'country=country_code' \
-F 'service=service_code'
                

پارامتر action دارای مقدار get_number شده است
همچنین پارامتر service اضافه شده است
مشاهده لیست سرور ها
مشاهده لیست کشور ها

#json
# نمونه خروجی
[
    {
    "phone":"+989150681843",
    "order_id":"3762"
    }
]

                

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

نام پارامتر	نوع پارامتر	توضیحات
api	String	کلید API شما
action	String	get_status
server	String	شماره سرور یا برای انتخاب تمام سرور ها از عبارت any استفاده کنید
country	String	کد کشور یا برای انتخاب تمام کشور ها از عبارت any استفاده کنید
service	String	کد سرویس که همان نام سرویس می باشد و گاها از مخفف استفاده شده است

خروجی

نام خروجی	توضیحات
phone	شماره تلفن
order_id	id سفارش جهت انجام عملیات بعدی

دریافت کد sms

#curl
#نمونه درخواست دریافت کد
curl \
-X GET http://arzancell.com/api/handler.php \
-F 'api=your_api_key' \
-F 'action=check_order' \
-F 'order_id=order_id'
                

مقدار پارامتر order_id را در مرحله دریافت شماره از قبل داریم

#json
# نمونه خروجی
[
    {
    "phone":"+989150681843",
    "code":"708303"
    }
]

                

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

نام پارامتر	نوع پارامتر	توضیحات
api	String	کلید API شما
action	String	check_order
order_id	String	شماره سفارش که در قسمت دریافت شماره داده شد

خروجی

نام خروجی	توضیحات
phone	شماره تلفن
code	درصورت عدم دریافت کد مقدار آن خالی می باشد

لغو سفارش

#curl
#نمونه درخواست لغو سفارش
curl \
-X GET http://arzancell.com/api/handler.php \
-F 'api=your_api_key' \
-F 'action=cancel_order' \
-F 'order_id=order_id'
                

مقدار پارامتر order_id را در مرحله دریافت شماره از قبل داریم

#text
# نمونه خروجی

CANCELED

                

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

نام پارامتر	نوع پارامتر	توضیحات
api	String	کلید API شما
action	String	cancel_order
order_id	String	شماره سفارش که در قسمت دریافت شماره داده شد

خروجی

CANCELED

خطاها

API ما در طول عملیات های مختلف ممکن است از ارور های زیر استفاده کند:

خطا	توضیحات
INVALID REQUEST	درخواست معتبر نمی باشد. باید پارامترهای درخواستتان را چک کنید
INVALID API	کلید api نامعتبر است
NOT ENOUGH BALANCE	موجودی حساب کافی نمی باشد
INVALID COUNTRY	کد کشور اشتباه است. مشاهده لیست کشور ها
INVALID SERVICE	سرویس انتخاب شده اشتباه است.
INVALID SERVER	سرور انتخاب شده اشتباه است. مشاهده لیست سرور ها
NO NUMBER	شماره های مورد نظر درحال حاضر تمام شده است
INVALID ORDER ID	شماره سفارش معتبر نمی باشد
UNCANCELLABLE ORDER	سفارش مورد نظر قابل لغو کردن نمی باشد
INVALID ACTION	عملیات معتبر نمی باشد
TRY AGAIN	احتمال خطا از سمت سرور وجود دارد، لطفا دوباره تلاش نمایید
EXPIRED SMS TIME	مدت زمان دریافت کد sms به پایان رسیده است و وجه به حساب شما عودت می شود
CAN NOT GET SMS	قابلیت دریافت کد sms درحال حاضر وجود ندارد، لطفا دوباره تلاش نمایید