此 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"}
YOUR_TOKEN 的有效期为一小时；可以使用 YOUR_REFRESH_TOKEN 延长有效期。


• 使用令牌异步启动流程

操作参数

以 JSON 对象发送 parameters。必填字段标记为 必填.

• 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=""'
如果文件可通过 URL 访问，可以忽略“file=@..”字段，直接在“fileUrl”字段中使用文件 URL。

API 会发送 JSON 响应确认流程已启动。请记下“trackingUrl”字段，以便跟踪已启动的流程。响应中还包含流程 ID；本例中的 ID 为 643： { "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 字段包含用于下载生成结果的经过身份验证的 URL： { "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": "" }

直接使用 actionResultsDownloadURLs 中提供的每个 URL 下载对应结果。

这份文档是否不清晰？ (Python, PHP, Java, JavaScript...) 需要帮助？

联系我们 此 API 也提供同步模式： 开发者 API : VirtualPhoneAssistant