واجهة برمجة تطبيقات المطورين

هاتفك التجاري،
الآن قابل للبرمجة.

Q: هل يمكنني البناء باستخدام واجهة برمجة التطبيقات دون إرسال رسائل نصية حقيقية؟

نعم | أنشئ مفتاح اختبار. تستخدم مفاتيح الاختبار نفس نقاط النهاية بنفس الأشكال، ولكن عمليات الإرسال تكون محاكاة، بحيث يمكنك التطوير وتشغيل CI دون إرسال أي رسالة SMS حقيقية. استبدلها بمفتاح مباشر عند النشر.

Q: هل توجد Webhooks؟

نعم. اشترك في الأحداث في الوقت الفعلي مثل message.received و call.completed ويقوم Ody بدفعها إلى نقطة النهاية الخاصة بك، موقعة وفقًا لمواصفات Standard Webhooks | مع سجل تسليم قابل للتصفح وعمليات تسليم اختبارية مدمجة.

Q: هل توجد حزم SDK رسمية؟

نعم | TypeScript و Python. هل تفضل لغة أخرى؟ يتم توفير الواجهة الكاملة كمواصفات OpenAPI 3.1 على /v1/api/openapi.json، بحيث يمكنك إنشاء عميل لأي شيء.

Q: هل يمكن لمفتاح API الوصول إلى مساحات عمل أخرى؟

لا. يرتبط المفتاح بمساحة العمل التي تم إنشاؤه فيها ويعمل كالعضو الذي أنشأه | تنطبق نفس قواعد الأذونات الخاصة بالتطبيق.

Q: ما هي الخطط التي تتضمن الوصول إلى واجهة برمجة التطبيقات؟

كل خطة | تتضمن واجهة برمجة التطبيقات و webhooks وخادم MCP بدءًا من خطة Starter.

كل جهة اتصال ومحادثة ورسالة ومكالمة في مساحة عمل Ody الخاصة بك خلف واجهة REST API واحدة نظيفة | بالإضافة إلى خادم MCP لمساعدي الذكاء الاصطناعي، و webhooks موثقة، وحزم SDK. مفتاح واحد، يتم إنشاؤه في دقائق.

احصل على مفتاح API الخاص بك→اقرأ الوثائق

مصادقة Bearer · مفاتيح ody_live_ و ody_test_ · الإعدادات ← Developer API

send-sms.sh | أول استدعاء API لك

# أرسل رسالة نصية قصيرة من رقم Ody الخاص بك
curl https://api.ody.co/v1/api/messages \
-H "Authorization: Bearer ody_live_…" \
-H "Idempotency-Key: order-1042-shipped" \
-d '{"to": "+15125550123", "body": "Your order shipped!"}'
201 تم الإنشاء
{
"conversationId": "b4a6f0…",
"message": { "body": "Your order shipped!" },
"simulated": false
}

مفتاح Idempotency على POST /messages | عمليات إعادة المحاولة خلال 24 ساعة تعيد تشغيل الاستجابة الأولى

ترقيم الصفحات باستخدام المؤشر على كل نقطة نهاية قائمة | اتبع nextCursor، لا تفوت أي صف

رؤوس RateLimit-Limit / -Remaining / -Reset القياسية، Retry-After عند 429

غلاف خطأ JSON موحد مع صدى X-Request-Id في كل استجابة

المنصة

كل ما تحتاجه للبناء على Ody

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

REST API

عمليات CRUD لجهات الاتصال، والمحادثات، وإرسال الرسائل النصية/الوسائط المتعددة، والبحث في الرسائل، وسجل المكالمات، وأرقام الهواتف على https://api.ody.co/v1/api | مصادقة Bearer باستخدام مفتاح ody_live_ الخاص بك.

GET /v1/api/contacts

MCP لمساعدي الذكاء الاصطناعي

قم بتوصيل ChatGPT أو Claude أو Cursor بـ https://api.ody.co/v1/mcp ويحصل مساعدك على 11 أداة | سرد وتحديث جهات الاتصال، قراءة المحادثات، البحث في الرسائل، إرسال الرسائل النصية | محددة النطاق بواسطة مفتاحك.

11 tools · /v1/mcp

Webhooks موثقة

Webhooks صادرة مع توقيع HMAC لـ Standard-Webhooks | رؤوس webhook-id و webhook-timestamp و webhook-signature | عمليات إعادة محاولة تلقائية، وأسرار لكل نقطة نهاية يمكنك تدويرها في أي وقت.

webhook-signature: v1,…

وضع الاختبار

تتصرف مفاتيح ody_test_ تمامًا مثل المفاتيح الحية، ولكن إرسال الرسائل يتم محاكاته | لا تغادر أي رسالة نصية قصيرة حقيقية. وجه CI الخاص بك إلى الإنتاج ونم مرتاحًا.

"simulated": true

حزم SDK لـ TypeScript و Python

عملاء رسميون، مكتملو الأنواع مع ترقيم صفحات تلقائي، وأخطاء مكتملة الأنواع، وعمليات إرسال متطابقة، والتحقق من توقيع webhook مدمج | حتى لا تضطر أبدًا إلى كتابة HMAC يدويًا مرة أخرى.

await ody.messages.send(…)

OpenAPI 3.1

يتم وصف السطح بأكمله في مواصفات واحدة قابلة للقراءة آليًا على /v1/api/openapi.json | أنشئ عملاء، أو خوادم وهمية، أو فقط قم بتغذيتها لوكيل الترميز بالذكاء الاصطناعي الخاص بك.

GET /v1/api/openapi.json

أقل امتياز

مفاتيح تفعل ما تقوله فقط

أنشئ مفاتيح في تطبيق Ody ضمن الإعدادات ← Developer API وضيق نطاق كل منها ليناسب تمامًا النطاقات التي يحتاجها التكامل | سبعة نطاقات عبر جهات الاتصال والمحادثات والرسائل والأرقام و webhooks. مفتاح لوحة تحكم للقراءة فقط لا يمكنه أبدًا إرسال رسالة نصية إلى عميل.

ody_live_… · مفتاح محدد النطاق

✓contacts:read
✕contacts:write
✓conversations:read
✕conversations:write
✓messages:send
✓numbers:read
✕webhooks:manage

بروتوكول سياق النموذج

الصق كتلة واحدة، وذكائك الاصطناعي جاهز للمكالمات

نفس مفتاح API يشغل خادم MCP. ضع هذا التكوين في ChatGPT أو Claude أو Cursor واطلب من مساعدك متابعة المحادثات غير المقروءة، أو صياغة الردود، أو إرسال رسالة نصية إلى عميل | كل استدعاء محدد النطاق بما يسمح به المفتاح.

استكشف خادم MCP→

mcp.json

{
"mcpServers": {
"ody": {
"url": "https://api.ody.co/v1/mcp",
"headers": {
"Authorization": "Bearer ody_live_…"
}
}
}
}

ابدأ البناء

من الصفر إلى أول SMS في خمس دقائق

احصل على مفتاح، قم بإجراء استدعاء curl واحد، وستكون قد أرسلت رسالة نصية. يتوفر المرجع الكامل لـ API، وأدلة الـ webhook، والبدء السريع لـ SDK في مركز المساعدة.

تصفح وثائق API→افتح الإعدادات ← Developer API

يتم إنشاء مفاتيح API بواسطة مالكي مساحة العمل والمسؤولين ضمن الإعدادات ← Developer API.

الأسئلة الشائعة

إجابات على أسئلة المطورين

ماذا يمكن لواجهة برمجة التطبيقات أن تفعل اليوم؟

إدارة كاملة لجهات الاتصال؛ سرد وقراءة المحادثات وتعيين حالتها؛ إرسال رسائل SMS و MMS؛ البحث في سجل رسائلك؛ سحب سجل المكالمات والبريد الصوتي مع النصوص؛ وسرد أرقام هواتف مساحة عملك. يتوفر المرجع الكامل في وثائق المطورين على help.ody.co.

هل يمكنني البناء باستخدام واجهة برمجة التطبيقات دون إرسال رسائل نصية حقيقية؟

هل توجد Webhooks؟

هل توجد حزم SDK رسمية؟

هل يمكن لمفتاح API الوصول إلى مساحات عمل أخرى؟

ما هي الخطط التي تتضمن الوصول إلى واجهة برمجة التطبيقات؟

Resources

Learn more

Guides to the concepts behind this feature.

What businesses need to know about CPaaSLearn how CPaaS APIs differ from UCaaS employee calling and CCaaS contact-center suites, and where SIP and WebRTC still sit underneath.Read guide What businesses need to know about MCPHow the Model Context Protocol standardizes the connection between AI assistants and external systems, and what an MCP server for a phone system exposes.Read guide What engineers need to know about SIPHow RFC 3261 signaling (INVITE, ACK, BYE) relates to SDP, RTP media, trunks, and registration.Read guide

أفضل مع مجموعتك التقنية

واجهة برمجة التطبيقات (API) هي السطح الكامل. التكاملات هي المسار بدون تعليمات برمجية.

المفاتيح المحددة النطاق، وwebhooks، وحزم تطوير البرامج (SDKs) تغطي كل ما تريد بناءه. Slack وMake وCSV تغطي المهام التي لا ينبغي لمعظم الفرق أن تضطر لكتابتها.

Makeالأتمتة

سيناريو بدلاً من معالج webhook، عندما يكون ذلك كافياً.

قم بتشغيل سيناريو Make من حدث مكالمة Ody. استخدم واجهة برمجة التطبيقات (API) عندما تحتاج إلى الثبات (idempotency)، والتقسيم (pagination)، ورمزك الخاص. استخدم Make عندما تحتاج إلى توسيع النطاق (fan-out) اليوم.

تشغيل السيناريو

MKon-call-completedتم إرجاع معرف التنفيذ

توسيع النطاق بدون تعليمات برمجية

اطلع على تكامل Make→

Slackالإشعارات

تنبيهات القناة دون كتابة تطبيق Slack.

OAuth، اختر قناة، انتهى. المكالمات الفائتة، رسائل البريد الصوتي، والملخصات تُنشر هناك. قم بإنشاء خاصتك باستخدام webhooks عندما تحتاج إلى حمولة مختلفة.

#front-desk

✦مكالمة فائتة · Sophie TranOAuth بنقرة واحدة

لا يوجد روبوت للصيانة

اطلع على تكامل Slack→

CSV importاستيراد البيانات