الشركاء

لنشاط يخدم عملاءه: منصة، أو وكالة، أو شركة برمجيات. يربط كل عميل من عملائك رقم واتساب الخاص به من داخل منتجك، وتدير أنت الجميع عبر الـ API. صلاحية الشريك باتفاق: راسلنا لتصبح شريكًا.

كيف يعمل#

كل عميل حساب مستقل تحت حسابك. له أرقامه ومفاتيح API الخاصة به والويب هوك والمحادثات وجهات الاتصال. لا يرى عميل بيانات عميل آخر، وتحتفظ أرقام كل عميل بإيقاعها وحمايتها الخاصة.

ما يشاركك فيه العميل:

• أرقام باقتك. أرقام باقتك تغطي أرقامك وأرقام كل عملائك معًا.
• حدود باقتك، إن كان لها حدود (رسائل في اليوم وما شابه): عدّ واحد لك ولكل عملائك.
• ميزاتك. للعميل الميزات التي في باقتك.
• حالة حسابك. ما دام حسابك موقوفًا يتوقف عملاؤك أيضًا، ويعودون معه.
• فاتورتك. تدفع أنت عن أرقام عملائك، كما يلي.
• رسائل فريقك. ليس للعميل أشخاص خاصون به. التنبيهات عن أرقامه تصل إلى فريقك، يسبقها اسم العميل.

أضف عميلًا واربط رقمه#

1. أضف العميل: POST /v1/clients مع name. في الرد id الخاص به.
2. أنشئ له مفتاحًا: POST /v1/clients/{id}/keys مع name. يحمل الرد المفتاح في data.token مرة واحدة: احفظه، فلن يظهر مجددًا.
3. استخدم مفتاح العميل في كل ما عدا ذلك: به يضيف POST /v1/instances رقمًا لذلك العميل. ثم اعرض GET /v1/instances/{id}/qr في منتجك، كما في ربط رقم.
4. استقبل منه: اضبط الويب هوك للعميل بمفتاحه، PATCH /v1/webhook، كما في الويب هوك والأحداث. قد يكون لكل عميل عنوانه، أو عنوانك أنت للجميع.

curl -X POST https://threadwire.net/api/v1/clients \
  -H "Authorization: Bearer YOUR_PARTNER_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Cairo Bakery"}'

اعرض رمز QR في منتجك أنت#

يربط عميلك رقمه على شاشاتك، لا على شاشاتنا أبدًا:

• GET /v1/instances/{id}/qr يرد بـ data.image، صورة تضعها في <img src> كما هي، وdata.value، النص لترسم الرمز بأي مكتبة QR. الرمز يتغيّر: اجلبه من جديد كل بضع ثوانٍ حتى يُربط الرقم.
• أو POST /v1/instances/{id}/pairing-code مع رقم الهاتف في phone: يكتب عميلك الرمز في واتساب ← الأجهزة المرتبطة ← الربط برقم الهاتف بدلًا من ذلك.
• تعرف أنه رُبط من ويب هوك instance.status، أو حين تصبح status هي working في GET /v1/instances/{id}. أعطِ الرقم external_ref الخاص بك حين تضيفه، وجده مجددًا بـ GET /v1/instances?external_ref=….
• على الهاتف، تعرض قائمة واتساب ← الأجهزة المرتبطة الربط باسم Threadwire.

الباقي في ربط رقم: ما تعنيه كل إجابة أثناء الربط، وكيف تعيد تشغيل الرقم أو توقفه أو تفك ربطه أو تحذفه.

مفاتيح العميل#

• access هي full (الافتراضي)، أو send (إرسال وقراءة)، أو read.
• مع instance_id يعمل المفتاح على ذلك الرقم من أرقام العميل فقط.
• GET /v1/clients/{id}/keys يعرض مفاتيحه بأسمائها وصلاحياتها، ولا يعرض المفاتيح نفسها أبدًا.
• DELETE /v1/clients/{id}/keys/{key} يلغي مفتاحًا فورًا.

للعميل حتى 10 مفاتيح.

أدِر عملاءك#

• GET /v1/clients يعرضهم، الأحدث أولًا، ولكلٍّ status (active أو suspended) وعدد instances لديه.
• GET /v1/clients/{id} يعرض عميلًا. وPATCH /v1/clients/{id} يغيّر اسمه.
• DELETE /v1/clients/{id} يحذف عميلًا مع مفاتيحه وسجله نهائيًا. ويرد بـ 409 ما دام للعميل أرقام: احذفها أولًا بمفتاحه، DELETE /v1/instances/{id}.

فاتورتك#

تدفع كل شهر، بعد انتهائه، عن كل رقم كان مربوطًا لك أو لعملائك يومًا واحدًا على الأقل فيه. في يوم 1 من الشهر نرسل الفاتورة بالبريد إلى مسؤولي حسابك: عدد الأرقام، وسعر الرقم، والإجمالي. وتعرض صفحة الفواتير في لوحة التحكم أرقام هذا الشهر حتى الآن، وفواتيرك، وطريقة الدفع. ادفع قبل التاريخ المكتوب في الفاتورة، ثم اضغط دفعت فاتورة هناك مع مرجع التحويل.

الفاتورة غير المدفوعة توقف الـ API والإرسال لك ولعملائك بعد أيام من تاريخ استحقاقها، مع حفظ أحداث الويب هوك. تبقى أرقامك مربوطة، ويعود كل شيء بمجرد وصول دفعتك إلينا. وتعرض صفحة العملاء في لوحة التحكم عملاءك، ولكل عميل أرقامه وعدد أرقامه هذا الشهر.

من يستطيع#

مفتاح حساب الشريك الذي يملك صلاحية الإدارة فقط. مفتاح الإرسال أو القراءة، ومفتاح الرقم الواحد، ومفتاح العميل نفسه، كلها ترد بـ 403. والحساب الذي ليس شريكًا يرد بـ 403 مع feature_not_included.