SMS Activate Logo

دليل المطوّر

وثائق المطورين

يقدم SMS Activate واجهة برمجة تطبيقات مؤتمتة بالكامل للمستخدمين الذين يحتاجون استئجار أرقام هواتف مؤقتة على نطاق واسع.

Create an API key in your dashboard and send it in the X-API-KEY header to https://api.smsactivate.uk. Order a number with POST /get_numbers using a service code and numeric country ID, then poll GET /status/{order_id} for the code. This API receives codes on a number you order. It does not send codes to your own users.

ابدأ الآن

أنشئ مفتاح API في لوحة التحكم ثم استخدمه في طلب من جهة الخادم.

لا تضع مفتاح API فعّالاً أبداً في كود المتصفح أو لقطات الشاشة أو المستودعات العامة.

فتح مفاتيح API

What does a first integration look like, end to end?

Start with GET /balance. A failed first call usually means the key or header is wrong.

Check what is live before you order: GET /services for service codes, GET /countries/{service} for country IDs, GET /offers/{service}/{country} for current offers. Availability changes; the catalog here is a reference, not a promise of stock. Browse all services.

POST /get_numbers with service and country. The response gives you an order id and a phone number; save the id.

Poll GET /status/{order_id} until the status reads received, then read sms_code.

What happens to an order after you place it?

An order moves through states, and what you can do depends on the state.

Active means the number is waiting for an SMS. While active you can ask for another SMS with POST /resend/{order_id} on a supported activation, or cancel an eligible one with POST /cancel/{order_id}. Cancel only works 2 to 20 minutes after purchase, and only before an SMS arrives.

Received means the code arrived. An expired order ran out its 20-minute window with no SMS and returns its stored status. An eligible activation that receives no SMS is refunded to your wallet. Read the FAQ.

Check the cancel response before you retry anything. If a purchase response is uncertain, do not order again until its status is clear. Contact support.

What mistakes cost first-time integrators the most?

Putting the key in browser code or a public repo. Keep it on a server you control.

Ordering before checking availability. GET /offers/{service}/{country} first saves a failed order.

Polling without a stop. GET /sms/{order_id} is rate-limited, so use GET /status/{order_id} and stop at a final state: received, cancelled, expired or refunded.

Retrying a purchase that came back uncertain. A 503 can mean the order went through and the answer got lost. Contact support.

Reusing an idempotency key for a different purchase. Use the same key only to check the outcome of the same purchase request.

Assuming the code will be accepted. Acceptance is the receiving service's decision, not ours.

Buying a one-time activation for an account that will ask for a code again - rentals are for that: 24 to 1,344 hours on the same number.

1. المصادقة

احصل على مفتاح API من إعدادات لوحة التحكم. يجب أن تتضمن جميع طلبات API الترويسة التالية:

X-API-KEY: your_api_key_here

2. عنوان URL الأساسي

تستخدم جميع طلبات API عنوان URL الأساسي هذا:

https://api.smsactivate.uk

مثال على الطلب

ينشئ هذا الطلب طلباً وقد يخصم من محفظتك. استبدل الخدمة والدولة في المثال باختيار متاح لحسابك.

curl -X POST https://api.smsactivate.uk/get_numbers   -H "X-API-KEY: YOUR_API_KEY"   -H "Content-Type: application/json"   -d '{"service":"tg","country":2}'

مرجع API

تعرض كل عملية مدخلاتها ومثالاً على الطلب واستجابة تمثيلية وأهم الأخطاء. يمكن لتكاملات API الحالية متابعة استخدام نقاط النهاية السابقة؛ ونوصي بنقاط النهاية المعتمدة على المنتجات أدناه للتكاملات الجديدة. تستخدم الأمثلة معرّفات وقيماً توضيحية. أرسل الطلبات الموثّقة من خادمك مع ترويسة مفتاح API.

ابدأ من هنا

GET/balanceاقرأ الرصيد الحالي لمحفظتك.

مفتاح API مطلوب.

المعلمات

لا شيء
لا توجد معلمات استعلام.

مثال على الطلب

curl https://api.smsactivate.uk/balance -H "X-API-KEY: YOUR_API_KEY"

الاستجابة

{ "balance": "10.0000" }

Errors

تعيد نقطة النهاية الرصيد الحالي للحساب الموثّق.

الحصول على رقم وإدارته

POST/get_numbersأنشئ طلب تفعيل.

مفتاح API مطلوب.

المعلمات

service
سلسلة نصية مطلوبة. رمز الخدمة، مثل tg.
country
عدد صحيح مطلوب. معرّف الدولة الرقمي.
operator
سلسلة نصية اختيارية. القيمة الافتراضية any.
max_price
رقم اختياري. السعر الأقصى؛ يُقبل maxPrice أيضاً.
min_price
رقم اختياري؛ يُقبل minPrice أيضاً.
any_price
قيمة منطقية اختيارية؛ يُقبل anyPrice أيضاً.
product
اختياري: standard (الافتراضي) أو api_links. API Links هي مشتريات مخزون بيع نهائي.
idempotency_key
UUID اختياري للتفعيلات القياسية. أعد استخدام المفتاح نفسه فقط لطلب الشراء نفسه عند التحقق من نتيجته.
quantity
عدد صحيح اختياري من 1 إلى 100 لطلبات مخزون API Links؛ الافتراضي 1. طلبات التفعيل القياسية تكون لرقم واحد.

مثال على الطلب

curl -X POST https://api.smsactivate.uk/get_numbers \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"service":"tg","country":2}'

الاستجابة

{
  "id": "ORDER_ID",
  "phone": "10000000000",
  "price": "0.2500",
  "balance_remaining": "9.7500"
}

Errors

HTTP 400: الاختيار غير متاح أو حد السعر أو رصيد غير كافٍ. HTTP 409: طلب سابق ما زال قيد الفحص. HTTP 503: فشل مؤقت أو طلب غير مؤكد؛ إذا ذكرت الاستجابة أن المطابقة مطلوبة فلا تعد المحاولة وتواصل مع الدعم.

GET/sms/{order_id}اطلب فحصاً جديداً لحالة طلب نشط.

مفتاح API مطلوب. نقطة النهاية هذه لها حد للطلبات.

المعلمات

order_id
قيمة مسار مطلوبة تُعاد عند إنشاء الطلب.

مثال على الطلب

curl https://api.smsactivate.uk/sms/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"

الاستجابة

{
  "status": "received",
  "sms_code": "123456",
  "raw_sms": "Your verification code is 123456"
}

Errors

HTTP 400: فحص SMS غير متاح لهذا الطلب. HTTP 404: الطلب غير موجود. HTTP 502: فشل فحص مؤقت. تعيد الطلبات المنتهية حالتها المخزنة دون فحص خارجي جديد.

GET/status/{order_id}اقرأ حالة الطلب ورسائل SMS المستلمة.

مفتاح API مطلوب.

المعلمات

order_id
قيمة مسار مطلوبة تُعاد عند إنشاء الطلب.

مثال على الطلب

curl https://api.smsactivate.uk/status/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"

الاستجابة

{
  "status": "received",
  "sms_code": "123456",
  "raw_sms": "Your verification code is 123456"
}

Errors

الاستجابة مقتصرة على طلب الحساب الموثّق. إذا فشل استعلام الحالة تعيد API خطأ؛ تحقق من معرّف الطلب وأعد المحاولة لاحقاً إذا كانت الخدمة غير متاحة مؤقتاً.

POST/resend/{order_id}اطلب رسالة SMS أخرى لتفعيل نشط مدعوم.

مفتاح API مطلوب.

المعلمات

order_id
قيمة مسار مطلوبة. بلا جسم طلب.

مثال على الطلب

curl -X POST https://api.smsactivate.uk/resend/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"

الاستجابة

{ "message": "Resend request successful. Waiting for new SMS." }

Errors

HTTP 400: إعادة الإرسال غير مقبولة أو انتهى الطلب. HTTP 409: إعادة الإرسال غير متاحة لهذا الطلب. HTTP 500: تعذّر إكمال إعادة الإرسال.

POST/cancel/{order_id}اطلب إلغاء تفعيل مؤهل.

مفتاح API مطلوب.

المعلمات

order_id
قيمة مسار مطلوبة. بلا جسم طلب.

مثال على الطلب

curl -X POST https://api.smsactivate.uk/cancel/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"

الاستجابة

{
  "message": "Number cancelled and balance refunded",
  "refunded_amount": "0.2500",
  "new_balance": "10.0000"
}

Errors

الإلغاء متاح فقط للتفعيلات النشطة المؤهلة، بعد 2 إلى 20 دقيقة من الشراء وقبل وصول SMS. تستخدم الإيجارات /rent/cancel/{order_id}؛ أما API Links فهي بيع نهائي. تعيد عمليات الإلغاء غير المؤهلة أو غير المؤكدة خطأ. اقرأ استجابة الإلغاء قبل إعادة المحاولة.

GET/reactivate/{order_id}/optionsتحقق من سعر إعادة التفعيل الحالي وتفاصيله.

مفتاح API مطلوب.

المعلمات

order_id
قيمة مسار مطلوبة للطلب الأصلي.

مثال على الطلب

curl https://api.smsactivate.uk/reactivate/ORDER_ID/options -H "X-API-KEY: YOUR_API_KEY"

الاستجابة

{
  "price": 0.25,
  "duration": 20,
  "phone": "10000000000",
  "service": "tg",
  "country": 2
}

Errors

HTTP 400: إعادة التفعيل غير مدعومة أو غير متاحة. HTTP 409: إعادة التفعيل غير متاحة لهذا الطلب. HTTP 503: تعذّر تأكيد سعر حالي صالح.

POST/reactivate/{order_id}أعد تفعيل تفعيل مؤهل بالسعر الحالي.

مفتاح API مطلوب.

المعلمات

order_id
قيمة مسار مطلوبة للطلب الأصلي. بلا جسم طلب.

مثال على الطلب

curl -X POST https://api.smsactivate.uk/reactivate/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"

الاستجابة

{
  "message": "Number reactivated successfully.",
  "id": "NEW_ORDER_ID",
  "phone": "10000000000",
  "price": 0.25,
  "balance_remaining": 9.75
}

Errors

HTTP 400: إعادة التفعيل غير مدعومة أو رصيد المحفظة غير كافٍ. HTTP 409: غير متاح لهذا الطلب. HTTP 503: تعذّر تأكيد النتيجة؛ تواصل مع الدعم قبل إعادة المحاولة.

GET/orders/{order_id}اقرأ تفاصيل أحد طلباتك.

مفتاح API مطلوب.

المعلمات

order_id
قيمة مسار مطلوبة تُعاد عند إنشاء الطلب.

مثال على الطلب

curl https://api.smsactivate.uk/orders/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"

الاستجابة

Returns the order record with buyer-facing fields, including its status and remaining time where applicable. Internal routing IDs and cost fields are not returned.

Errors

HTTP 404: الطلب غير موجود أو لا ينتمي إلى حسابك.

اختيار الخدمات والدول والأسعار

الخدماتابحث في كتالوج الخدمات بالاسم أو الرمز. قد يتغير التوفر؛ تحقق من نقطة النهاية المباشرة قبل الطلب.
الاسم / الرمز1,638 مدخلات في الكتالوج
  • 163COMwp
  • 11688hn
  • 11and1ahs
  • 11xbetwj
  • 224bettinglh
  • 22dehandsapd
  • 22domainserc
  • 22ememainblx
  • 22ГИСbcg
  • 332Redqi
  • 3360Krediayo
  • 33Funauw
  • 44FunLitehk
  • 5500pxfpx
  • 551exchboc
  • 551exchangeexc
  • 77-Elevenaws
  • 8888casinoll
  • 9999 Mdbrv
  • 99acresfw
  • 99appki
  • 999Gameqkb
  • 999k Outletamq
  • AA23acv
  • AA9Agn
  • AAadharhra
  • Abastece-aíanb
  • AAbbottags
  • Ace2Threerh
  • AAcimacim
  • AAckoamf
  • AdaKamiko
  • AAdaModalbdo
  • AAdanibq
  • AAdidasan
  • AAditya Birlaqff
  • AAdmiralBetbst
  • AAdobebyh
  • Advertsagw
  • AAEG Presentsrsn
  • AAffirmbow
  • AAfreecaTVaip
  • AGIBANKsa
  • AAgodaag
  • AgriDevelopcs
  • AAgroinformqu
  • AAhlanbsm
  • AAiqfomebbi
  • AAir Milesbsy
  • AAirba Freshbnp
  • Airbnbuk
  • AAirtaskerbyd
  • Airtelzl
  • AAirtimeacy
  • AISwv
  • AAIS PLAYaxs
  • Aitujj
  • Akudorf
  • Akulakutm
  • Alchemyaav
  • Alfabt
  • Alfagiftbn
  • AAlfamidibgt
  • AAlFursanbxr
  • AAlgidalp
  • AAlibabaab
  • AliExpresshx
  • AAlignableaul
  • Alipay/Alibaba/1688hw
  • All Accessajy
  • Allegroyn
  • AlloBanknh
  • AAllofreshaeo
  • AAltyn-ial
  • AAmap 高德地图btx
  • AAmarthaFinbsv
  • Amasiayo
  • AAmaze Super Appbzk
  • Amazonam
  • AAme Digitalafi
  • AAmwayaee
  • AAngel Oneaha
  • Ankamaalg
  • AAnnoncelightbyw
  • Any Otherot
  • AOLpm
  • ApostaGanhaml
  • Applewx
  • Apteka Aprelaeh
  • AptekaRUgk
  • AAptekiPlusrq
  • AAR Lensaco
  • ArenaPlusabt
  • AArgentamo
  • AAri10blq
  • AASAASbqr
  • AAsdahs
  • AAsiaMilesajp
  • AAsianDatingayb
  • AAskablebpi
  • AAspirationaptn
  • Astra Otoshopafd
  • AstraPayaem
  • Astropaygr
  • AASVLAbuj
  • AAti Subhl
  • AAtlas Earthawq
  • AAtlasbusatb
  • AttaPollanl
  • AAUBANKdu
  • Auchanst
  • AAudibleaud
  • AAukroaox
  • AAuthentifyccy
  • AAuthor24kd
  • AAutodeskbbl
  • Autoruaej
  • AAv100proajl
  • AAvitoav
  • AVONff

التوفر المباشر ومثال على الاستجابة:

GET https://api.smsactivate.uk/services
{
  "services": ["tg", "wa", "go"],
  "providers": { "source-counts": "per active catalog" },
  "generated_at": "ISO 8601 timestamp"
}

يوفّر الكتالوج الأسماء والرموز للبحث. التوفر مباشر وقد يختلف عن هذه القائمة؛ يوضح هذا JSON شكل الاستجابة وليس المخزون الحالي.

الدولمعرّفات الدول الرقمية من كتالوج لوحة التحكم. لا توجد نقطة نهاية عامة في API لقائمة الدول للتفعيلات القياسية.
الدولة / المعرّف الرقمي206 مدخلات في الكتالوج
  • Afghanistan74
  • Albania155
  • Algeria58
  • Angola76
  • Anguilla181
  • Antigua and Barbuda169
  • Argentina39
  • Armenia148
  • Aruba179
  • Australia175
  • Austria50
  • Azerbaijan35
  • Bahamas122
  • Bahrain145
  • Bangladesh60
  • Barbados118
  • Belarus51
  • Belgium82
  • Belize124
  • Benin120
  • Bermuda195
  • Bhutan158
  • Bolivia92
  • Bosnia108
  • Botswana123
  • Brazil73
  • Brunei121
  • Bulgaria83
  • Burkina Faso152
  • Burundi119
  • Cambodia24
  • Cameroon41
  • Canada36
  • Cape Verde186
  • Cayman Islands170
  • Central African Republic125
  • Chad42
  • Chile151
  • China3
  • Colombia33
  • Comoros133
  • Congo150
  • Costa Rica93
  • Croatia45
  • Cuba113
  • Cyprus77
  • Czech63
  • Denmark172
  • Djibouti168
  • Dominica126
  • Dominican Republic109
  • DR Congo18
  • Ecuador105
  • Egypt21
  • Equatorial Guinea167
  • Eritrea176
  • Estonia34
  • Ethiopia71
  • Faroe Islands202
  • Fiji189
  • Finland163
  • France78
  • French Guiana162
  • Gabon154
  • Gambia28
  • Georgia128
  • Germany43
  • Ghana38
  • Gibraltar201
  • Greece129
  • Grenada127
  • Guadeloupe160
  • Guatemala94
  • Guinea68
  • Guinea-Bissau130
  • Guyana131
  • Haiti26
  • Honduras88
  • Hong Kong14
  • Hungary84
  • Iceland132
  • India22
  • Indonesia6
  • Iran57
  • Iraq47
  • Ireland23
  • Israel13
  • Italy86
  • Ivory Coast27
  • Jamaica103
  • Japan182
  • Jersey194
  • Jordan116
  • Kazakhstan2
  • Kenya8
  • Kosovo203
  • Kuwait100
  • Kyrgyzstan11
  • Laos25
  • Latvia49
  • Lebanon153
  • Lesotho136
  • Liberia135
  • Libya102
  • Liechtenstein200
  • Lithuania44
  • Luxembourg165
  • Macao20
  • Madagascar17
  • Malawi137
  • Malaysia7
  • Maldives159
  • Mali69
  • Malta199
  • Mauritania114
  • Mauritius157
  • Mexico54
  • Moldova85
  • Monaco144
  • Mongolia72

شكل استجابة العروض لخدمة ودولة:

[
  { "name": "any", "offers": [{ "price": 0.25, "count": 4 }] }
]

تحدد معرّفات الكتالوج خيارات الدول، ولا تضمن وجود عروض مباشرة. تحقق من /offers/{service}/{country} لمعرفة التوفر.

GET/servicesتحقق من توفر الخدمات حالياً.

عامة - لا يلزم مفتاح API.

المعلمات

لا شيء
نقطة النهاية هذه لا تقبل معلمات استعلام.

مثال على الطلب

curl https://api.smsactivate.uk/services

الاستجابة

Returns the current services array and generated_at timestamp. See the searchable Services catalog below for code/name lookup; it is a maintained reference, not a live availability guarantee.

Errors

قد يتغير التوفر. تحقق من نقطة النهاية المباشرة و /offers/{service}/{country} قبل الطلب.

GET/countries/{service}اعرض معرّفات الدول التي تتوفر فيها أرقام حالياً لخدمة ما.

عامة - لا يلزم مفتاح API.

المعلمات

service
رمز خدمة مطلوب، مثل tg.

مثال على الطلب

curl https://api.smsactivate.uk/countries/tg

الاستجابة

{ "countries": [2, 6, 187] }

Errors

تتطابق معرّفات الدول مع كتالوج الدول أدناه. يتغير التوفر؛ تحقق من /offers/{service}/{country} قبل الطلب. نقطة النهاية هذه لها حد للطلبات.

GET/offers/{service}/{country}/deliveryاطّلع على معدلات تسليم الرموز الأخيرة لكل فئة سعرية.

عامة - لا يلزم مفتاح API.

المعلمات

service
رمز خدمة مطلوب، مثل tg.
country
معرّف دولة رقمي مطلوب.

مثال على الطلب

curl https://api.smsactivate.uk/offers/tg/2/delivery

الاستجابة

{
  "window_days": 30,
  "tiers": { "0.2500": { "orders": 120, "codes": 108, "delivery_pct": 90, "best": true } }
}

Errors

HTTP 400: خدمة أو دولة غير صالحة. لا تُعرض الفئات التي لا تحتوي على رموز مُسلَّمة. تُخزَّن النتائج مؤقتاً نحو 5 دقائق وتغطي آخر window_days يوماً. نقطة النهاية هذه لها حد للطلبات.

GET/operators?service={service}&country={country}اعرض المشغّلين المتاحين لخدمة ودولة.

عامة - لا يلزم مفتاح API.

المعلمات

service
رمز خدمة مطلوب، مثل tg.
country
معرّف دولة رقمي مطلوب.

مثال على الطلب

curl 'https://api.smsactivate.uk/operators?service=tg&country=2'

الاستجابة

[
  { "name": "any", "localName": "Any Operator" },
  { "name": "example", "localName": "Example operator" }
]

Errors

تعتمد القائمة على الدولة المحددة والتوفر الحالي. المعلمتان service و country مطلوبتان؛ القيم المفقودة أو غير الصالحة تعيد HTTP 422.

GET/offers/{service}/{country}تحقق من العروض لتركيبة واحدة من خدمة ودولة.

عامة - لا يلزم مفتاح API.

المعلمات

service
قيمة مسار مطلوبة. استخدم رمز خدمة تعيده /services، مثل tg.
country
قيمة مسار مطلوبة. معرّف الدولة الرقمي؛ استخدم كتالوج الدول في لوحة التحكم للتفعيلات القياسية. لا توجد نقطة نهاية عامة في API تعرض معرّفات الدول هذه.

مثال على الطلب

curl https://api.smsactivate.uk/offers/tg/2

الاستجابة

[
  {
    "name": "any",
    "offers": [{ "price": "0.2500", "count": 4 }]
  }
]

Errors

قد يعيد زوج غير مدعوم أو غير متاح قائمة فارغة. بيانات العروض مخزنة مؤقتاً؛ وقد يستغرق غياب البيانات من الذاكرة المؤقتة وقتاً أطول أثناء فحص التوفر.

مراجعة النشاط السابق

GET/ordersتصفّح سجل طلباتك، الأحدث أولاً.

مفتاح API مطلوب.

المعلمات

page
رقم صفحة اختياري؛ الافتراضي 1.
per_page
حجم صفحة اختياري؛ الافتراضي 20 والحد الأقصى 100.
status
اختياري: active أو completed (أو received) أو cancelled أو expired أو refunded. اتركه فارغاً أو استخدم all لتضمين كل الحالات.
search
بحث اختياري برقم الهاتف.
category
اختياري: rents أو links أو numbers.

مثال على الطلب

curl 'https://api.smsactivate.uk/orders?page=2&per_page=100&status=received&category=numbers' -H "X-API-KEY: YOUR_API_KEY"

الاستجابة

{
  "current_page": 2,
  "data": [{ "id": "ORDER_ID", "status": "received", "phone": "10000000000" }],
  "first_page_url": "…?page=1",
  "last_page": 4,
  "last_page_url": "…?page=4",
  "next_page_url": "…?page=3",
  "per_page": 100,
  "prev_page_url": "…?page=1",
  "total": 350
}

Errors

تابع next_page_url حتى يصبح null. القيمة الافتراضية لـ page هي 1؛ والقيمة الافتراضية لـ per_page هي 20 وتُقيَّد القيم بين 1 و100. يقبل status القيم active وcompleted/received وcancelled وexpired وrefunded؛ وall أو قيمة غير معروفة تترك status بلا تصفية. يطابق search أرقام الهواتف. يقبل category القيم rents وlinks وnumbers؛ وتُتجاهل الفئات غير المعروفة. تحتاج السجلات الكبيرة إلى عدة طلبات للصفحات.

الإيجارات

GET/rent/servicesتحقق من خدمات الإيجار لدولة ومدة.

مفتاح API مطلوب.

المعلمات

country
معرّف دولة صحيح اختياري؛ الافتراضي 2.
duration
ساعات اختيارية؛ الافتراضي 24. النطاق المسموح: من 24 إلى 1,344 ساعة.

مثال على الطلب

curl 'https://api.smsactivate.uk/rent/services?country=2&duration=24' -H "X-API-KEY: YOUR_API_KEY"

الاستجابة

Returns rental availability, with service codes and current prices for the selected country and duration.

Errors

HTTP 400: لا يوجد رقم إيجار متاح لهذا الاختيار. HTTP 422: دولة أو مدة غير صالحة. HTTP 503: كتالوج الإيجار غير متاح مؤقتاً.

POST/rent/orderأنشئ طلب إيجار.

مفتاح API مطلوب.

المعلمات

service
رمز خدمة مطلوب (سلسلة نصية).
country
معرّف دولة مطلوب (عدد صحيح).
duration
ساعات مطلوبة، من 24 إلى 1,344.
operator
سلسلة نصية اختيارية؛ الافتراضي any.

مثال على الطلب

curl -X POST https://api.smsactivate.uk/rent/order \
  -H "X-API-KEY: YOUR_API_KEY" -H "Content-Type: application/json" \
  -d '{"service":"tg","country":2,"duration":24}'

الاستجابة

{
  "message": "Number rented successfully.",
  "id": "ORDER_ID",
  "phone": "10000000000",
  "price": 2.50,
  "balance_remaining": 7.50
}

Errors

HTTP 400: طلب غير صالح أو رصيد غير كافٍ. HTTP 409: لا يوجد إيجار متاح. HTTP 503: النتيجة قيد المراجعة؛ لا تعد المحاولة حتى يفحص الدعم الطلب.

POST/rent/cancel/{order_id}اطلب إلغاء إيجار مؤهل.

مفتاح API مطلوب.

المعلمات

order_id
قيمة مسار مطلوبة. بلا جسم طلب.

مثال على الطلب

curl -X POST https://api.smsactivate.uk/rent/cancel/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"

الاستجابة

Returns the cancellation result. Refunds may remain pending verification after cancellation is accepted.

Errors

الإلغاء مقتصر على الإيجارات النشطة المؤهلة، بعد 2 إلى 20 دقيقة من الشراء وقبل وصول SMS. HTTP 404: الإيجار غير موجود. HTTP 409: الإيجار غير مؤهل. إذا قُبل الإلغاء فقد يبقى الاسترداد قيد التحقق.

GET/rent/extend/{order_id}/optionsتحقق من خيارات التمديد المتاحة لإيجار.

مفتاح API مطلوب.

المعلمات

order_id
قيمة مسار مطلوبة للإيجار.

مثال على الطلب

curl https://api.smsactivate.uk/rent/extend/ORDER_ID/options -H "X-API-KEY: YOUR_API_KEY"

الاستجابة

{
  "options": [{ "duration": 24, "price": 2.50 }],
  "expires_at": "2026-10-06T12:00:00Z"
}

Errors

HTTP 404: الإيجار غير موجود. HTTP 409: الإيجار غير مؤهل (يفتح التمديد بعد أول 20 دقيقة، ويجب أن يكون الإيجار active أو received، أو أن هناك تمديداً سابقاً قيد المراجعة). HTTP 503: التمديد غير متاح مؤقتاً أو تعذّر تحميل الخيارات؛ أعد المحاولة لاحقاً. نقطة النهاية هذه لها حد للطلبات.

POST/rent/extend/{order_id}مدّد إيجاراً نشطاً.

مفتاح API مطلوب.

المعلمات

order_id
قيمة مسار مطلوبة للإيجار.
duration
مطلوب: 24 أو 72 أو 168 أو 336 أو 720 أو 1,440 أو 2,160 أو 4,320 ساعة. اختر من استجابة الخيارات الحالية.
expected_price
رقم مطلوب منسوخ من استجابة الخيارات الحالية.
Idempotency-Key
ترويسة طلب UUID v4 مطلوبة. أعد استخدامها فقط لإعادة محاولة تمديد نفسه بأمان.

مثال على الطلب

curl -X POST https://api.smsactivate.uk/rent/extend/ORDER_ID \
  -H "X-API-KEY: YOUR_API_KEY" -H "Content-Type: application/json" \
  -H "Idempotency-Key: 3f6c1a52-8b1e-4c47-9d0a-6a1f2c9e7b10" \
  -d '{"duration":24,"expected_price":2.50}'

الاستجابة

{
  "message": "Rental extended successfully.",
  "attempt_id": "REQUEST_UUID",
  "status": "settled",
  "charged": 2.50,
  "new_expires_at": "2026-10-10T12:00:00Z",
  "balance_remaining": 7.50
}

Errors

HTTP 422: duration أو expected_price أو Idempotency-Key مفقود/غير صالح. HTTP 409: الإيجار غير مؤهل، أو لم تعد المدة أو السعر متاحين، أو سبق استخدام Idempotency-Key. HTTP 202: التمديد قيد المراجعة؛ لا تعد المحاولة بمفتاح idempotency جديد. HTTP 503: تعذّر تأكيد التمديد؛ تواصل مع الدعم.

التحقق عبر البريد الإلكتروني

GET/emails/catalog?site={site}اعرض نطاقات عناوين التحقق المتاحة لموقع.

مفتاح API مطلوب.

المعلمات

site
نطاق موقع ويب مطلوب، مثل example.com.

مثال على الطلب

curl 'https://api.smsactivate.uk/emails/catalog?site=example.com' -H "X-API-KEY: YOUR_API_KEY"

الاستجابة

[{ "name": "sample-domain.test", "price": 0.10, "stock": 5 }]

Errors

HTTP 422: قيمة site غير صالحة. HTTP 503: كتالوج البريد غير متاح مؤقتاً.

POST/emails/buyاشترِ عنوان تحقق واحداً.

مفتاح API مطلوب.

المعلمات

site
نطاق موقع ويب مطلوب.
domain
نطاق مطلوب يُختار من استجابة الكتالوج الحالية.

مثال على الطلب

curl -X POST https://api.smsactivate.uk/emails/buy \
  -H "X-API-KEY: YOUR_API_KEY" -H "Content-Type: application/json" \
  -d '{"site":"example.com","domain":"sample-domain.test"}'

الاستجابة

Returns an order object and balance_remaining when the purchase is confirmed.

Errors

HTTP 400: رصيد المحفظة غير كافٍ. HTTP 409: النطاق غير متوفر في المخزون. HTTP 503: الشراء قيد المراجعة؛ لا تعد المحاولة حتى يفحص الدعم الطلب.

POST/emails/{order_id}/reorderاطلب العنوان نفسه مرة أخرى بعد انتهاء الطلب السابق.

مفتاح API مطلوب.

المعلمات

order_id
قيمة مسار مطلوبة لطلب بريد منتهٍ (رقمية). بلا جسم طلب.

مثال على الطلب

curl -X POST https://api.smsactivate.uk/emails/ORDER_ID/reorder -H "X-API-KEY: YOUR_API_KEY"

الاستجابة

Returns the new email order, same shape as the email order response. The price is quoted at order time and charged from your balance.

Errors

HTTP 404: الطلب غير موجود. HTTP 409: لم ينتهِ الطلب السابق، أو أن إعادة طلب جارية بالفعل، أو لا يمكن إعادة طلب هذا العنوان الآن. HTTP 503: التحقق عبر البريد غير متاح مؤقتاً. نقطة النهاية هذه لها حد للطلبات.

GET/emails/historyاعرض طلبات التحقق عبر البريد الإلكتروني الخاصة بك.

مفتاح API مطلوب.

المعلمات

page
رقم صفحة اختياري؛ الافتراضي 1.
per_page
حجم صفحة اختياري؛ الافتراضي 20 والحد الأقصى 50.

مثال على الطلب

curl 'https://api.smsactivate.uk/emails/history?page=1&per_page=20' -H "X-API-KEY: YOUR_API_KEY"

الاستجابة

Returns paginated order data and page metadata.

Errors

إذا لم يكن جدول طلبات البريد متاحاً، تعيد API مصفوفة data فارغة.

GET/emails/status/{order_id}اقرأ طلب تحقق أو حدّثه.

مفتاح API مطلوب.

المعلمات

order_id
قيمة مسار مطلوبة تعيدها استجابة الشراء.

مثال على الطلب

curl https://api.smsactivate.uk/emails/status/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"

الاستجابة

Returns the order status and available verification result fields.

Errors

HTTP 404: الطلب غير موجود. HTTP 503: تعذّر تحديث الحالة. تتضمن الاستجابة فقط الحقول المتاحة للطلب.

DELETE/emails/{order_id}اطلب إلغاء طلب تحقق عبر البريد الإلكتروني.

مفتاح API مطلوب.

المعلمات

order_id
قيمة مسار مطلوبة تعيدها استجابة الشراء.

مثال على الطلب

curl -X DELETE https://api.smsactivate.uk/emails/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"

الاستجابة

Returns the cancellation result. The refund can remain pending verification.

Errors

يجب أن ينتمي الطلب إلى حسابك وأن يكون مؤهلاً للإلغاء؛ راجع رسالة الخطأ المُعادة لمعرفة حالة الطلب الحالية. إذا ذكرت الاستجابة أن الإلغاء لم يُؤكَّد بعد (HTTP 503)، فانتظر بضع دقائق وأرسل الطلب مرة أخرى.

Webhooks

GET/webhookاقرأ إعدادات webhook الخاصة بك.

مفتاح API مطلوب.

المعلمات

لا شيء
لا توجد معلمات استعلام.

مثال على الطلب

curl https://api.smsactivate.uk/webhook -H "X-API-KEY: YOUR_API_KEY"

الاستجابة

Returns the saved endpoint configuration. The signing secret is not returned by this read request.

Errors

تعيد الإعدادات الحالية للحساب الموثّق.

PUT/webhookأنشئ عنوان URL لـ webhook أو حدّثه.

مفتاح API مطلوب.

المعلمات

url
عنوان URL عام بصيغة HTTPS مطلوب على المنفذ 443. تُرفض العناوين المحلية والخاصة.

مثال على الطلب

curl -X PUT https://api.smsactivate.uk/webhook \
  -H "X-API-KEY: YOUR_API_KEY" -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/hooks/sms"}'

الاستجابة

Returns the saved configuration. On first setup the signing secret is returned once; store it safely.

Errors

HTTP 422: عنوان URL ليس عنوان HTTPS عاماً مقبولاً.

POST/webhook/rotate-secretاستبدل سر التوقيع لـ webhook المُعدّ.

مفتاح API مطلوب.

المعلمات

لا شيء
بلا جسم طلب. اضبط webhook أولاً.

مثال على الطلب

curl -X POST https://api.smsactivate.uk/webhook/rotate-secret -H "X-API-KEY: YOUR_API_KEY"

الاستجابة

{ "secret": "NEW_SECRET_SHOWN_ONCE" }

Errors

HTTP 404: لم يُعدّ أي webhook. احفظ السر الجديد بأمان؛ فهو يُعاد في استجابة التدوير هذه وليس في نقطة نهاية القراءة.

DELETE/webhookاحذف إعدادات webhook الخاصة بك.

مفتاح API مطلوب.

المعلمات

لا شيء
بلا جسم طلب.

مثال على الطلب

curl -X DELETE https://api.smsactivate.uk/webhook -H "X-API-KEY: YOUR_API_KEY"

الاستجابة

{ "configured": false }

Errors

يحذف إعدادات webhook للحساب الموثّق.

POST/webhook/testأرسل حدثاً تجريبياً إلى نقطة النهاية المُعدّة.

مفتاح API مطلوب.

المعلمات

لا شيء
بلا جسم طلب. اضبط webhook أولاً.

مثال على الطلب

curl -X POST https://api.smsactivate.uk/webhook/test -H "X-API-KEY: YOUR_API_KEY"

الاستجابة

{
  "delivered": true,
  "http_status": 200,
  "message": "Your server accepted the test message."
}

Errors

HTTP 404: لم يُعدّ أي webhook. يُبلغ تسليم الاختبار عن delivered=false عندما لا يقبله خادمك.

GET/webhook/deliveriesراجع ما يصل إلى 50 محاولة تسليم حديثة لـ webhook.

مفتاح API مطلوب.

المعلمات

لا شيء
لا توجد معلمات استعلام.

مثال على الطلب

curl https://api.smsactivate.uk/webhook/deliveries -H "X-API-KEY: YOUR_API_KEY"

الاستجابة

{
  "data": [{ "id": 42, "event_id": "EVENT_ID", "event_type": "sms.received", "status": "success", "attempts": 1, "http_status": 200 }]
}

Errors

تعيد أحدث 50 عملية تسليم HTTP لـ webhook، الأحدث أولاً.

POST/webhook/deliveries/{id}/retryأعد محاولة أحد تسليمات webhook الخاصة بك الآن.

مفتاح API مطلوب.

المعلمات

id
قيمة مسار مطلوبة لسجل التسليم.

مثال على الطلب

curl -X POST https://api.smsactivate.uk/webhook/deliveries/42/retry -H "X-API-KEY: YOUR_API_KEY"

الاستجابة

{ "status": "success", "http_status": 200 }

Errors

HTTP 404: التسليم غير موجود. نقطة النهاية هذه لها حد للطلبات.

4. الفوترة

يُخصم من رصيدك عند تقديم الطلب. التفعيلات التي لا تتلقى أي رسالة نصية خلال مهلة الـ20 دقيقة يُسترد مبلغها إلى رصيدك. تختلف قواعد الإلغاء والاسترداد بين الإيجارات والبريد الإلكتروني وAPI Links.

5. الإلغاء والاستردادات

في طلبات الأرقام (التفعيلات)، يمكنك طلب الإلغاء بعد أول دقيقتين وقبل انتهاء مهلة التفعيل البالغة 20 دقيقة، وفقط ما دامت لم تصل أي رسالة نصية. تُعيد الإلغاءات المؤهلة والمؤكدة مبلغ الطلب إلى رصيدك.

لا يمكن إلغاء التفعيل بعد وصول رسالة نصية أو بعد انتهاء مهلته. إذا لم يتلقَّ تفعيل مؤهل أي رسالة خلال مهلة الـ20 دقيقة، يُسترد مبلغ الطلب إلى رصيدك.

يمكن إلغاء الإيجارات ضمن النافذة نفسها من دقيقتين إلى 20 دقيقة ما دام لم يصل أي رمز. استرداد الإيجار قيد التحقق وليس تلقائيًا.

يمكن إلغاء طلبات التحقق عبر البريد الإلكتروني بعد دقيقتين إذا لم يصل أي رمز. وإذا لم يصل رمز خلال 20 دقيقة، يُلغى الطلب تلقائيًا ويُعاد المبلغ إلى رصيدك. الأرقام بالجملة وAPI Links غير قابلة للاسترداد بعد تسليمها؛ ويتم فحص استرداد الإيجارات يدويًا.

إذا تعذّر تأكيد الإلغاء، تواصل مع الدعم قبل إعادة المحاولة.

Frequently asked questions

How do I authenticate with the API?

Create or rotate a key in your dashboard. Send it in the X-API-KEY header with every request. The key is shown once when you create or rotate it. Keep it server-side. Open your dashboard.

What do I need for my first order?

A service code and a numeric country ID. Find them with GET /services and GET /countries/{service}, then check GET /offers/{service}/{country}. Prices are shown live in the dashboard. See live prices.

How do I read the code that arrives?

Poll GET /status/{order_id} and read sms_code when the status is received. GET /sms/{order_id} is rate-limited; do not use it for routine polling.

What if no SMS arrives?

An eligible activation with no SMS in its 20-minute window is refunded. You can also cancel an eligible active activation 2 to 20 minutes after purchase, before an SMS arrives. If a purchase response is uncertain, do not retry it; contact support. Read the FAQ.

Can I cancel an order?

For eligible active activations: POST /cancel/{order_id}, 2 to 20 minutes after purchase, before an SMS arrives. Rentals use POST /rent/cancel/{order_id}. API Links are final sale.

Does this API send verification codes to my users?

No. It receives codes on a number you order. If you need to send codes to your own users, this API is not the tool for that job.

How do webhooks work?

Set a public HTTPS URL on port 443 with PUT /webhook; the signing secret is returned once. Verify the signature as sha256= HMAC-SHA256 of "." and reject timestamps more than five minutes old. Test with POST /webhook/test.

تحتاج حدًا أعلى أو تكاملًا مخصصًا؟ تواصل مع فريقنا. أو افتح لوحة تحكمك.