Method: echo

يؤدي إلى رد سلسلة تم إرسالها من العميل.

إذا واجهت نقطة النهاية خطأً أثناء معالجة الطلب، يجب أن يكون نص الاستجابة من نقطة النهاية هذه من النوع ErrorResponse.

يظهر مثال على الطلب على النحو التالي:


{
  "requestHeader": {
    "protocolVersion": {
      "major": 2
    },
    "requestId": "G1MQ0YERJ0Q7LPM",
    "requestTimestamp": {
      "epochMillis": "1481899949606"
    },
    "paymentIntegratorAccountId": "InvisiCashUSA_USD"
  },
  "clientMessage": "Client echo message"
}

مثال على الاستجابة للنجاح:


{
  "responseHeader": {
    "responseTimestamp": {
      "epochMillis":"1481899950236"
    }
  },
  "clientMessage": "Client echo message",
  "serverMessage": "Debug ID 12345"
}

طلب HTTP

POST https://www.integratorhost.example.com/v2/echo

نص الطلب

يحتوي نص الطلب على بيانات بالبنية التالية:

تمثيل JSON
{
  "requestHeader": {
    object (RequestHeader)
  },
  "clientMessage": string
}
الحقول
requestHeader

object (RequestHeader)

مطلوب: العنوان المشترك لجميع الطلبات.

clientMessage

string

مطلوب: يتم إرسال رسالة إلى صدى صوت في الردّ.

نص الاستجابة

كائن الاستجابة لطريقة الصدى.

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "clientMessage": string,
  "serverMessage": string
}
الحقول
responseHeader

object (ResponseHeader)

مطلوب: عنوان مشترك لجميع الردود.

clientMessage

string

مطلوب: تم استلام الرسالة في الطلب.

serverMessage

string

اختياري: رسالة الخادم، بشكل مستقل عن clientMessage التي يتم ارتدادها.

RequestHeader

كائن العنوان المحدَّد في جميع الطلبات المُرسَلة إلى الخادم.

تمثيل JSON
{
  "requestId": string,
  "requestTimestamp": {
    object (Timestamp)
  },
  "protocolVersion": {
    object (Version)
  },
  "paymentIntegratorAccountId": string
}
الحقول
requestId

string

مطلوب: المعرّف الفريد لهذا الطلب.

هذه سلسلة يبلغ الحد الأقصى للطول 100 حرف، وتحتوي فقط على الأحرف "a-z" و"A-Z" و"0-9" و"":" و"-" و"_".

requestTimestamp

object (Timestamp)

مطلوب: الطابع الزمني لهذا الطلب. يجب أن يتحقّق المستلِم من أنّ الطابع الزمني الحالي هو ± 60 ثانية من "الآن" ويرفض الطلب إذا لم يكن كذلك. إنّ الطابع الزمني لهذا الطلب غير ثابت عند إعادة المحاولة.

protocolVersion

object (Version)

مطلوب: نسخة هذا الطلب.

paymentIntegratorAccountId

string

مطلوب: يحدد حسابًا فريدًا يخضع لقيود تعاقدية.