توثيق API, مساعد هاتفي افتراضي تفاعلي للعقارات والورش والصيدليات والعيادات الطبية.

API : مساعد هاتفي افتراضي تفاعلي للعقارات والورش والصيدليات والعيادات الطبية.

هذا API سهل الاستخدام. ما عليك سوى اتباع هذه الخطوات

إنشاء حساب مجاني
انقر على الرابط الذي يصلك عبر البريد الإلكتروني لتأكيد عنوانك.
إنشاء رمز باستخدام بيانات الاعتماد

يمكنك استخدام أي لغة لإجراء استدعاء CURL هذا. (Python, PHP, Java, JavaScript...) هل تحتاج إلى مساعدة؟

curl --location --request POST 'https://mxprocess.com/api/login_check' \
                                        --header 'Content-Type: application/json' \
                                        --data-raw '{"username":"YOUR_LOGIN","password":"YOUR_PASSWORD"}'

{"token": "YOUR_TOKEN","refresh_token": "YOUR_REFRESH_TOKEN"}

استخدم الرمز لبدء العملية بشكل غير متزامن

معلمات الإجراء

أرسل parameters ككائن JSON. تُعلّم الحقول المطلوبة بـ مطلوب.

businessDomain — enum:real_estate,garage,pharmacy,medical,dental,veterinary,physiotherapy,chiropractic,optician,hair_salon,beauty_salon,spa_wellness,restaurant,hotel,law_firm,accounting_firm,insurance_agency,travel_agency,plumbing,electrician,hvac,locksmith,cleaning_service,pest_control,moving_company,landscaping,fitness_gym,driving_school,tutoring_center,daycare,software_development,data_ai,cybersecurity,cloud_infrastructure_devops,networks_telecom,it_support_operations.
businessProfileId — integer; الحد الأدنى 1.
businessName — string; الحد الأقصى 120 حرفاً.
businessContext — string; الحد الأقصى 2000 حرفاً.
businessPhoneNumber — string; الحد الأقصى 32 حرفاً.
businessLanguage — enum:en,fr,es,de,hi,zh,ar.
businessAppointmentDurationMinutes — integer; الحد الأدنى 5; الحد الأقصى 480.
sessionId — integer; الحد الأدنى 1.
language — enum:en,fr,es,de,hi,zh,ar.

curl --location 'https://mxprocess.com/api/files/start-process' \
--header 'Authorization: Bearer YOUR_TOKEN' \
--form 'file=@"/FILE_PATH/FILE_NAME"' \
--form 'actionName="VirtualPhoneAssistant"' \
--form 'parameters={"businessDomain":"real_estate","businessProfileId":1,"businessName":"example","businessContext":"example","businessPhoneNumber":"example","businessLanguage":"en","businessAppointmentDurationMinutes":5,"sessionId":1,"language":"en"}' \
--form 'async="true"' \
--form 'fileUrl=""' \
--form 'fileContent=""'

{
    "id": 643,
    "actionParameters": [],
    "dateOfDemand": "2024-01-28T11:03:25+01:00",
    "hostedFileIds": [
        {
            "fileId": 608,
            "parameters": ""
        }
    ],
    "action": {
        "actionName": "VirtualPhoneAssistant",
        "slug": "virtual-phone-assistant",
        "jsonRequestSample": null,
        "jsonResponseSample": null,
        "specificDeveloperRequestDocumentation": null,
        "specificDeveloperResponseDocumentation": null,
        "longDescription": null
    },
    "user": [],
    "accomplished": false,
    "userIsNotifiedByEmail": "off",
    "userIsNotifiedByPostQuery": "off",
    "actionResults": [],
    "priceInTokensAtTimeOfUse": 3,
    "retryCount": 0,
    "trackingUrl": "https://mxprocess.com/api/actions/get-action-infos/643"
}

لمتابعة التقدم، أجرِ طلب GET بسيطاً (يمكنك إجراء هذا الاستدعاء كل 10 ثوانٍ):

curl --location 'https://mxprocess.com/api/actions/get-action-infos/643' \
--header 'Authorization: Bearer YOUR_TOKEN'
}}

"accomplished": false

{
  "id": 643,
  "actionParameters": [],
  "dateOfDemand": "2024-01-28T11:03:25+01:00",
  "startTime": null,
  "endTime": null,
  "hostedFileIds": [
    {
      "fileId": 608,
      "parameters": ""
    }
  ],
  "action": {
    "actionName": "VirtualPhoneAssistant",
    "slug": "virtual-phone-assistant",
    "jsonRequestSample": null,
    "jsonResponseSample": null,
    "specificDeveloperRequestDocumentation": null,
    "specificDeveloperResponseDocumentation": null,
    "longDescription": null
  },
  "user": [],
  "accomplished": false,
  "userIsNotifiedByEmail": "off",
  "userIsNotifiedByPostQuery": "off",
  "actionResults": [],
  "priceInTokensAtTimeOfUse": 3,
  "retryCount": 0,
  "executionPlannedAt": null,
  "trackingUrl": ""
}

"accomplished": true

{
  "actionResultsDownloadURLs": [
    "https://mxprocess.com/api/actions/download-result/643/35084b44a841ec597be3048df44145e8.txt.log/YOUR_TOKEN"
  ],
  "id": 643,
  "actionParameters": {
    "commandParameters": ""
  },
  "dateOfDemand": "2024-01-28T11:03:25+01:00",
  "startTime": "2024-01-28T11:24:49+01:00",
  "endTime": "2024-01-28T11:25:09+01:00",
  "hostedFileIds": [
    {
      "fileId": 608,
      "parameters": ""
    }
  ],
  "action": {
    "actionName": "VirtualPhoneAssistant",
    "slug": "virtual-phone-assistant",
    "jsonRequestSample": null,
    "jsonResponseSample": null,
    "specificDeveloperRequestDocumentation": null,
    "specificDeveloperResponseDocumentation": null,
    "longDescription": null
  },
  "user": [],
  "accomplished": true,
  "userIsNotifiedByEmail": "off",
  "userIsNotifiedByPostQuery": "off",
  "actionResults": [
    [
      "35084b44a841ec597be3048df44145e8.txt.log"
    ]
  ],
  "priceInTokensAtTimeOfUse": 3,
  "retryCount": 0,
  "executionPlannedAt": null,
  "trackingUrl": ""
}

هل هذا التوثيق غير واضح؟ (Python, PHP, Java, JavaScript...) هل تحتاج إلى مساعدة؟

اتصل بنا يتوفر هذا API أيضاً في الوضع المتزامن: API للمطورين : VirtualPhoneAssistant