تمام پاسخ های موفق حاوی کد 20X می باشند و پاسخ های ناموفق هم با کد 40X ارسال می شوند ، بعلاوه فیلد status در پاسخ ها هم نشان دهنده موفقیت آمیز بودن عملیات است

برای شروع از صفحه اول یک توکن جدید بسازید و دقت داشته باشید که توکن را کپی کنید زیرا بیش از یک بار به نمایش در نخواهد آمد

هشدار

درصورتی که در روز بیش از 50 شماره دریافت کنید ولی هیچکدام را فعال سازی نکنید حساب کاربری شما مسدود و طی پیامکی به شما اطلاع داده می شود، برای باز کردن حساب باید با پشتیبانی سایت تماس بگیرید.

نکته

برای افزایش امنیت برای webhook یک آدرس مخفی در سرور خود قرار دهید یا با یک رمز طولانی از آن محافظ کنید
نمونه
example.com/my_looooooooooooooong_secret_url
example.com/webhook?secret=mySuperSecretKey

موضوعات

دریافت مقدار موجودی

نکته

در api تمام قیمت های ارائه شده به تومان می باشد

api/v1/user/credit [GET]

پاسخ دریافتی (status : 200)

{ "status": "success", "credit": 100000 }

دریافت قیمت ها برای سرویس

api/v1/pricing [POST]

لیست سرویس ها : کلیک کنید

نام پارامتر مورد نیاز توضیحات
service بله کد سرویس

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

{ "data":[ { "name":"رومانی", "count":188, "price":10000, "country":"romania" }, { "name":"کلمبیا", "count":5995, "price":10000, "country":"colombia" }, { "name":"مالزی", "count":14677, "price":10000, "country":"malaysia" },... ] }

دریافت قیمت ها برای چند سرویس

api/v1/pricing [POST]

حداکثر 5 سرویس را همزان می توانید سفارش دهید
لیست سرویس ها : کلیک کنید

نام پارامتر مورد نیاز توضیحات
services بله لیست سرویس ها را به صورت آرایه ارسال کنید

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

{ "data":[ { "name":"رومانی", "count":188, "price":10000, "country":"romania" }, { "name":"کلمبیا", "count":5995, "price":10000, "country":"colombia" }, { "name":"مالزی", "count":14677, "price":10000, "country":"malaysia" },... ] }

دریافت شماره

می توانید پارامتر URL هم ارسال کنید تا سرور پیامک های دریافتی را به آدرس شما ارسال کند.

api/v1/number [POST]

شماره ها پس از 15 دقیقه منقضی می شوند

لیست کشور ها : کلیک کنید

نام پارامتر مورد نیاز توضیحات
service بله کد سرویس
country بله کد کشور
callback خیر برای تنظیم webhook
پیام به صورت POST با فیلد هایی دقیقا مثل پاسخ بخش بررسی پیامک به سرور شما ارسال می شود

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

{ "data":{ "area_code":40, "number":"7519859XX", "number_id":"5eVm0gqD1d", "service":"telegram", "country":"romania", "is_rented":null, "expires_at":"2021-01-11T16:46:50.211439Z", "created_at":"2021-01-11T16:26:50.000000Z", "updated_at":"2021-01-11T16:26:50.000000Z" }, "status":"success" }

نمونه خطا

{"ok":false,"status":"error","message":"MESSAGE"}

دریافت شماره برای چند سرویس

می توانید پارامتر URL هم ارسال کنید تا سرور پیامک های دریافتی را به آدرس شما ارسال کند.

api/v1/number [POST]

شماره ها پس از 15 دقیقه منقضی می شوند

لیست کشور ها : کلیک کنید

نام پارامتر مورد نیاز توضیحات
services بله کد سرویس
country بله کد کشور
callback خبر برای تنظیم webhook
پیام به صورت POST با فیلد هایی دقیقا مثل پاسخ بخش بررسی پیامک به سرور شما ارسال می شود

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

{ "status":"success", "data":[ { "number":"96104612XX", "number_id":"zbqjMwE0kd", "area_code":7, "expires_at":"2021-01-11T16:42:13.845700Z", "price":12000, "callback":"", "updated_at":"2021-01-11T16:22:13.000000Z", "created_at":"2021-01-11T16:22:13.000000Z", "service":"telegram", "country":"russia" }, { "number":"96104612XX", "number_id":"Yer0MyGxWb", "area_code":7, "expires_at":"2021-01-11T16:42:13.851362Z", "price":12000, "callback":"", "updated_at":"2021-01-11T16:22:13.000000Z", "created_at":"2021-01-11T16:22:13.000000Z", "service":"whatsapp", "country":"russia" } ] }

بررسی دریافت پیامک

api/v1/number/{numberId} [GET]

هر 20 یا 30 ثانیه یک درخواست ارسال کنید درغیر اینصورت توسط سرور تا یک دقیقه بلاک می‌شوید

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

{ "data":{ "area_code":7, "number":"9610461240", "number_id":"Yer0MyGxWb", "service":"whatsapp", "country":"russia", "messages":[ { "id":"gl9avmeG1v", "content":"509773", "message_id":"ak5WDO14rTBc4IyAC906S4qIAJNPDsaQVqLCSoDA", "from":"whatsapp", "is_received":1, "created_at":"2021-01-11T16:24:02.000000Z", "updated_at":"2021-01-11T16:24:02.000000Z" } ], "is_rented":0, "expires_at":"2021-01-11 20:12:13", "created_at":"2021-01-11T16:22:13.000000Z", "updated_at":"2021-01-11T16:22:13.000000Z" }, "status":"success" }

لغو شماره

api/v1/number/{numberId} [DELETE]

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

{ "status":"success","message":"APPROPRIATE MESSAGE" }