نظرة عامة على API المفتوحة

طرق المصادقة وتنسيق الاستجابة ورموز الأخطاء ورموز اللغات المدعومة.

يشير {API} فيما يلي إلى عنوان الخدمة، ويمكنك العثور عليه في صفحة «الاتصال» في لوحة التحكم.

تحمل جميع الطلبات الترويسة Authorization: Bearer sk_live_... (تُنشأ في صفحة «الاتصال» في لوحة التحكم، وتُعرض مرة واحدة فقط، وتُحفظ على الخادم فقط).

تأتي الاستجابات دائمًا بالشكل {"code": "SUCCESS", "message": "", "data": ...}. عند الفشل يكون code رمز خطأ ثابتًا، فعليه تعتمد في تحديد المشكلة؛ أما message فهو للعرض البشري فقط. جميع المبالغ المالية تكون على شكل نصوص (strings).

رموز الأخطاء

codeالحالة
UNAUTHORIZEDمفتاح API غير صالح أو تم إلغاؤه
VALIDATION_ERRORالمعاملات غير صحيحة، ويحتوي data على الحقل المعني
NOT_FOUNDالمورد غير موجود (بما في ذلك الموارد التي لا تخصك)
PLAN_LIMIT_REACHEDتجاوز عدد المنتجات أو سعة قاعدة المعرفة أو عدد المقاعد في خطتك
CONVERSATION_CLOSEDانتهت المحادثة، يُرجى إنشاء محادثة جديدة
CONVERSATION_OPENلم تنتهِ المحادثة بعد، لذا لا يمكن التقييم
RATE_LIMITEDالطلبات متكررة أكثر من اللازم
USER_TOKEN_INVALIDتوقيع user_token غير صحيح أو منتهي الصلاحية
CHECKOUT_FAILEDانتهت صلاحية تأكيد الطلب، أو أن واجهة إنشاء الطلب غير متاحة مؤقتًا (عند النقر على «تأكيد الطلب» في widget)
ORIGIN_NOT_ALLOWEDالموقع الحالي ليس ضمن القائمة المسموح لها بالتضمين
LANGUAGE_NOT_SUPPORTEDاللغة غير مدعومة أو غير مفعّلة
CHANNEL_CHECK_FAILEDفشل التحقق من AppID / AppSecret للقناة، ويحتوي message على السبب الذي أعاده WeChat
CHANNEL_REMOVEDتم حذف القناة التي جاءت منها المحادثة، لذا لا يمكن إرسال الرد

رموز اللغات المدعومة: zh-CN، zh-TW، en، ja، ko، de، fr، es، pt، it، ru، ar، th، vi، id، ms، tr، nl، pl. أما الصيغ مثل zh-Hant وpt-BR وen_US فتُحوَّل تلقائيًا إلى الرمز المقابل.

هل كانت هذه الصفحة مفيدة؟

آخر تحديث: