القائمة السوداء
الرسالة إلى رقم في القائمة السوداء تُنشأ بالحالة status: "blocked" وerrorCode: "blacklisted" ولا تصل إلى أي هاتف. تتخطى الحملات هذه الأرقام، ويتخطاها الاستيراد، وترفضها خدمة التحقق مع 422 verify_recipient_blacklisted. الرد بكلمة STOP يضيف المرسل تلقائيا، والرد بكلمة START يزيل ذلك المدخل. انظر استقبال الرسائل.
كائن المدخل
Section titled “كائن المدخل”| الحقل | النوع | الوصف |
|---|---|---|
id |
string | blk_… |
phone |
string | E.164. |
reason |
string أو null | ملاحظتك. |
source |
string | manual، أو opt_out إذا رد المستلم بكلمة STOP. |
createdAt |
string |
عرض المداخل
Section titled “عرض المداخل”GET
/v1/blacklistblacklist:manageمن الأحدث إلى الأقدم، مقسمة إلى صفحات عبر limit وcursor.
curl https://api.smsfabric.com/v1/blacklist \ -H "X-Api-Key: $SMSFABRIC_API_KEY"{ "data": [ { "id": "blk_i3l6o9r2u5x8a1d4g7j0m3p6", "phone": "+201001234568", "reason": null, "source": "opt_out", "createdAt": "2026-11-18T19:04:11.000Z" }, { "id": "blk_j4m7p0s3v6y9b2e5h8k1n4q7", "phone": "+966501234567", "reason": "Asked by phone not to be contacted", "source": "manual", "createdAt": "2026-11-02T09:12:40.000Z" } ], "nextCursor": null}إضافة رقم
Section titled “إضافة رقم”POST
/v1/blacklistblacklist:manageيعيد 201 مع المدخل. يدعم Idempotency-Key. يُسجل في التدقيق باسم blacklist.added.
| حقل المحتوى | النوع | إلزامي | القيود |
|---|---|---|---|
phone |
string | نعم | E.164. |
reason |
string | لا | حتى 500 حرف. |
curl https://api.smsfabric.com/v1/blacklist \ -H "X-Api-Key: $SMSFABRIC_API_KEY" \ -H "Content-Type: application/json" \ -d '{"phone": "+966501234567", "reason": "Asked by phone not to be contacted"}'| الخطأ | متى |
|---|---|
409 already_blacklisted |
الرقم في القائمة أصلا. |
400 validation_failed |
الرقم ليس بصيغة E.164 صالحة. |
إزالة رقم
Section titled “إزالة رقم”DELETE
/v1/blacklist/:idblacklist:manageيعيد 204. يُسجل في التدقيق باسم blacklist.removed. تبقى الرسائل المحظورة سابقا محظورة، وتُرسل الجديدة.
curl -X DELETE https://api.smsfabric.com/v1/blacklist/blk_j4m7p0s3v6y9b2e5h8k1n4q7 \ -H "X-Api-Key: $SMSFABRIC_API_KEY"