v1 · 14 endpoint · instantreply.up.railway.app
REST API · v1.
واتساب + إنستغرام
Bearer auth. Cursor pagination. Idempotency keys. Webhooks موقّعة. الـ API التي كان فريقك سيبنيها لو امتلك عطلة نهاية الأسبوع.
اختر بيئة التشغيل
import InstantReply from '@instantreply/node'
const ir = new InstantReply({ apiKey: process.env.IR_API_KEY })
for await (const c of ir.conversations.list.autoPaginate({ status: 'active' })) {
if (c.last_message_preview?.includes('refund')) {
await ir.conversations.update(c.id, { tags: ['priority:refund'] })
}
}سطح v1
أربعة عشر endpoint وهيدر مصادقة واحد.
- GET
/v1/conversations - GET
/v1/conversations/:id - PATCH
/v1/conversations/:id - GET
/v1/conversations/:id/messages - POST
/v1/conversations/:id/messages - GET
/v1/contacts - GET
/v1/contacts/:id - PATCH
/v1/contacts/:id - GET
/v1/channels - GET
/v1/analytics/summary - GET
/v1/usage - GET
/v1/webhooks - POST
/v1/webhooks - DELETE
/v1/webhooks/:id
التصميم
خيارات مملّة، عن قصد.
- 01
Cursor pagination، دائمًا
كل endpoint قائمة يُرجع has_more وnext_cursor. لا سجلات مفقودة تحت الحمل، لا off-by-one.
- 02
Idempotency-Key على POST
مرّر UUID وأعد المحاولة بأمان لمدة 24 ساعة. تنطلق الآثار الجانبية مرة واحدة فقط.
- 03
X-Request-Id في كل ردّ
أَلصِق المعرّف في الدعم ونتتبّع النداء بالضبط، والردّ بالضبط، والنداء التابع بالضبط.
- 04
أخطاء بشكل ثابت
نفس غلاف JSON في كل فشل. code وmessage وdoc_url وrequest_id. بلا null مفاجئ.
الأخطاء
غلاف واحد، في كل مرّة.
بلا أعلام نجاح متداخلة. بلا خلط حالة الأحرف. بلا 200 صامت عند الفشل. إذا انكسر النداء، يخبرك الجسم بالضبط أي نداء وماذا توقّع وأين الوثائق.
// 422 Unprocessable Entity
{
"error": {
"code": "INVALID_PLATFORM",
"message": "Channel 'tiktok' is not yet supported on v1.",
"doc_url": "https://www.instantreply.co/api-docs#errors",
"request_id": "req_8f2a0b1c"
}
}