Documentation API, Assistant téléphonique virtuel interactif pour les agences immobilières, garages, pharmacies et cabinets médicaux.

Accueil Tarifs Paramètres Nous contacter

API : Assistant téléphonique virtuel interactif pour les agences immobilières, garages, pharmacies et cabinets médicaux.

Cette API est simple à utiliser. Il vous suffit de suivre ces étapes

Créer un compte gratuitement
Cliquez sur le lien reçu par e-mail pour confirmer votre adresse.
Générer un jeton avec vos identifiants

Vous pouvez utiliser n’importe quel langage pour effectuer cet appel CURL. (Python, PHP, Java, JavaScript...) Besoin d’aide ?

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

Si vos identifiants sont corrects, notre serveur vous fournira un jeton en réponse :

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

YOUR_TOKEN est valide pendant une heure ; sa durée peut être prolongée avec YOUR_REFRESH_TOKEN.

Utilisez le jeton pour démarrer le traitement

Paramètres de l’action

Envoyez parameters comme objet JSON. Les champs obligatoires sont marqués obligatoire.

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; minimum 1.
businessName — string; maximum 120 caractères.
businessContext — string; maximum 2000 caractères.
businessPhoneNumber — string; maximum 32 caractères.
businessLanguage — enum:en,fr,es,de,hi,zh,ar.
businessAppointmentDurationMinutes — integer; minimum 5; maximum 480.
sessionId — integer; minimum 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="false"' \
--form 'fileUrl=""' \
--form 'fileContent=""'

Si votre fichier est accessible par URL, ignorez le champ « file=@.. » et utilisez directement son URL dans le champ « fileUrl ».

L’API renvoie une réponse JSON confirmant la fin du traitement. Téléchargez les fichiers générés avec les URL authentifiées de actionResultsDownloadURLs.


{
    "actionResultsDownloadURLs": [
        "https://mxprocess.com/api/actions/download-result/1016/a62be5bf2ad15dc82940bcddbe3f000c.mp3.mp3/YOUR_TOKEN"
    ],
    "id": 1016,
    "actionParameters": [],
    "dateOfDemand": "2024-02-07T20:51:42+00:00",
    "startTime": "2024-02-07T20:51:46+01:00",
    "endTime": "2024-02-07T20:51:46+01:00",
    "hostedFileIds": [
        {
            "fileId": 1025,
            "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": [
        [
            "a62be5bf2ad15dc82940bcddbe3f000c.mp3.mp3",
            "https://mxprocessfiles.s3.eu-west-1.amazonaws.com/AudioToGPT/1016/a62be5bf2ad15dc82940bcddbe3f000c.mp3.mp3"
        ]
    ],
    "priceInTokensAtTimeOfUse": 15,
    "retryCount": 0,
    "executionPlannedAt": null,
    "trackingUrl": ""
}

Cette documentation n’est pas claire ? (Python, PHP, Java, JavaScript...) Besoin d’aide ?

Nous contacter Cette API est également disponible en mode asynchrone : API développeur : VirtualPhoneAssistant