{"info":{"_postman_id":"1bad8524-c2e6-4f9a-9002-fdb3fc2ade0b","name":"Documentation Ask Lab Api","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"26504117","collectionId":"1bad8524-c2e6-4f9a-9002-fdb3fc2ade0b","publishedId":"2sAY55axdg","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"1E2129","highlight":"002AFF"},"publishDate":"2025-07-22T14:20:57.000Z"},"item":[{"name":"Events","item":[{"name":"Get events by Bot and Date Range","id":"34e6fa31-fcb9-4361-a993-dddae227b319","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"startDate\": \"2024-11-14T00:10\",\n \"endDate\": \"2024-11-14T23:10\"\n\n}","options":{"raw":{"language":"json"}}},"url":"api.asklabai.com/events/byBotCsId/{botId}","description":"

POST /events/byBotCsId/{botId}

This endpoint allows the retrieval of events associated with a specific bot using the bot's ID.

Request Body

raw (application/json)
\n
- startDate: (string) The start date and time for the event retrieval.
  \n
- endDate: (string) The end date and time for the event retrieval.
  \n
\n

Request Path Variable

botId (string) - The ID of the bot for which the event statistics are being retrieved.

Response

The response is a JSON array with the following schema:

[\n  {\n    \"eventCode\": (number),\n    \"timeStamp\": (string),\n    \"eventId\": (string),\n    \"calleeId\": (string),\n    \"botCsId\": (string)\n  }\n]\n\n

Create Event Statistics by Bot ID

This endpoint allows you to retrieve event statistics for a specific bot by providing the bot ID in the request path.

Request Body

startDate (string) - The start date and time for the event statistics.
\n
endDate (string) - The end date and time for the event statistics.
\n

Request Path Variable

botId (string) - The ID of the bot for which the event statistics are being retrieved.

Example:

api.asklabai.com/events/byBotCsId/{botId}/stats\n\n

Response

The response will contain the event statistics for the specified bot in the following format:

{\n  \"100\": 0,\n  \"101\": 0,\n  \"103\": 0,\n  \"104\": 0,\n  \"105\": 0,\n  \"106\": 0,\n  \"110\": 0,\n  \"121\": 0,\n  \"200\": 0,\n  \"201\": 0,\n  \"202\": 0,\n  \"203\": 0\n}\n\n

Liste des codes d'evenement

Liés à l'appel

•⁠ ⁠100 : Appel inité
•⁠ ⁠110 : Appel initié opérateur
•⁠ ⁠101 : Ça sonne
•⁠ ⁠102 : Appel connecté
•⁠ ⁠103 : Appel terminé (raccroché)
•⁠ ⁠104 : Correspondant occupé
•⁠ ⁠105 : Appel échoué (probablement numéro pas attribué)
•⁠ ⁠106 : Pas de réponse
•⁠ ⁠121: Messagerie detectée

Statut de qualification du lead

•⁠ ⁠200 : Statut du lead inconnu
•⁠ ⁠201 : Lead qualifié
•⁠ ⁠202 : Lead disqualifié
•⁠ ⁠203 : Lead disqualifié car il nous a raccroché au nez

Retrieve Events by Callee ID

This endpoint allows you to retrieve events associated with a specific callee ID.

Request

Method: GET
\n
Endpoint: api.asklabai.com/events/byCalleeId/{calleeId}
\n
Path Parameter:
\n
- calleeId (string): The unique identifier for the callee whose events you want to retrieve. In this example, it is 68cdde3c2a86bf0dce30994e.
\n

Response

Status Code: 200 OK
\n
Content-Type: text/plain
\n
Response Format: The response will be a JSON array containing event objects with the following structure:
\n
- eventId (string): The unique identifier for the event.
  \n
- eventCode (integer): A code representing the type of event.
  \n
- timeStamp (string): The timestamp of when the event occurred.
  \n
- botCsId (string): The bot's customer service identifier.
  \n
- calleeId (string): The identifier of the callee.
  \n
- callId (string): The identifier for the call.
  \n
- twilioCallSid (string): The Twilio call SID associated with the event.
  \n
\n

Example Response

[\n  {\n    \"eventId\": \"\",\n    \"eventCode\": 0,\n    \"timeStamp\": \"\",\n    \"botCsId\": \"\",\n    \"calleeId\": \"\",\n    \"callId\": \"\",\n    \"twilioCallSid\": \"\"\n  }\n]\n\n

Use this endpoint to effectively gather event data related to a specific callee based on their unique identifier.

Create Bot Conversation

This endpoint allows you to create a new bot.

Request Body

name: The name of the bot .
\n
useCaseId: The ID of the use case associated with the bot .
\n
voiceId: The ID of the voice used for the conversation.
\n
emailReport: The email address for the conversation report.
\n
replicas: The number of replicas for the bot.
\n
fromNumber: The phone number from which the conversation is initiated.
\n
active: Indicates if the conversation is active.
\n
maxCallPerCallee: The maximum number of calls per callee.
\n
gSheetId: The ID of the Google Sheet associated with this bot.
\n

Response

Upon successful creation, the endpoint returns a status code of 200 with a Content-Type of text/plain. The response body contains the ID of the newly created bot conversation.

Example:

6735da5073bf4936985e59f1\n\n

","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"xi-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"1bad8524-c2e6-4f9a-9002-fdb3fc2ade0b","id":"1bad8524-c2e6-4f9a-9002-fdb3fc2ade0b","name":"Documentation Ask Lab Api","type":"collection"}},"urlObject":{"path":["botCs"],"host":["api.asklabai.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"155f1548-9b9e-4591-b36e-346d6284b4d1"},{"name":"Get Bot Details","id":"77bdabfc-3e61-46ea-839f-1dbf28b59173","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"api.asklabai.com/botCs/{botId}","description":"

Bot Details

This endpoint retrieves details of a specific bot using its ID.

Request

Path Parameters

botId (string, required): The ID of the bot.

Headers

No specific headers are required for this request.

Response

botId (string): The ID of the bot.
\n
voiceId (string): The ID of the voice associated with the bot.
\n
fromNumber (string): The phone number associated with the bot.
\n
emailReport (string): The email address for reporting.
\n
gSheetId (string): The ID of the Google Sheet associated with the bot.
\n
ownerId (string): The ID of the owner of the bot.
\n
useCaseId (string): The ID of the use case associated with the bot.
\n
active (boolean): Indicates if the bot is active.
\n
replicas (number): The number of replicas for the bot.
\n
maxCallPerCallee (number): The maximum number of calls per callee allowed for the bot.
\n

This endpoint retrieves details of a specific bot by providing the bot's ID in the URL.

Request

Method: GET
\n
URL: api.asklabai.com/botCs/{botId}
\n

Response

Status: 200
\n
Content-Type: text/json
\n

GET /botCs

This endpoint retrieves a list of botCs.

Request

There are no request parameters for this endpoint.

Response

The response is a JSON array containing all your bots objects with the following properties:

botId (string): The ID of the bot.
\n
atHandle (string): The handle for the bot.
\n
voiceId (string): The ID for the bot's voice.
\n
fromNumber (string): The number from which the bot operates.
\n
emailReport (string): The email address for reporting.
\n
gSheetId (string): The ID of the Google Sheet associated with the bot.
\n
ownerId (string): The ID of the owner of the bot.
\n
useCaseId (string): The ID of the use case for the bot.
\n
active (boolean): Indicates whether the bot is active.
\n
replicas (number): The number of replicas for the bot.
\n
maxCallPerCallee (number): The maximum number of calls per callee.
\n

Example response:

[\n    {\n        \"botId\": \"66d872b37e7dba64646c2fd6\",\n        \"atHandle\": \"TEST OWNER\",\n        \"voiceId\": \"JKPWJfiNeucVg6ncekqY\",\n        \"fromNumber\": \"+33712345687\",\n        \"emailReport\": \"jean@api.com\",\n        \"gSheetId\": \"13bKHVs30CmMnfU\",\n        \"ownerId\": \"66d872917e7dba64646c2fd4\",\n        \"useCaseId\": \"66d872aa7e7dba64646c2fd5\",\n        \"active\": true,\n        \"replicas\": 4,\n        \"maxCallPerCallee\": 1\n    },\n    {\n        \"botId\": \"6717b104ec067d5d3b1a2842\",\n        \"atHandle\": \"demo_artefact2\",\n        \"voiceId\": \"JKPWJfiNeucVg6ncekqY\",\n        \"fromNumber\": \"+33712345678\",\n        \"emailReport\": \"patrick@api.com\",\n        \"gSheetId\": \"13bKHVs30CmMnfU\",\n        \"ownerId\": \"66d872917e7dba64646c2fd4\",\n        \"useCaseId\": \"6717b253a6a7d92ae9d9fc1e\",\n        \"active\": true,\n        \"replicas\": 1,\n        \"maxCallPerCallee\": 1\n    },\n    {\n        \"botId\": \"6735da5073bf4936985e59f1\",\n        \"voiceId\": \"JKPWJfiNeucVg6ncekqY\",\n        \"fromNumber\": \"+33700000000\",\n        \"emailReport\": \"artefact@api.com\",\n        \"gSheetId\": \"13bKHVs30CmMnfU\",\n        \"ownerId\": \"66d872917e7dba64646c2fd4\",\n        \"useCaseId\": \"6717b239a6a7d92ae9d9fc1a\",\n        \"active\": true,\n        \"replicas\": 1,\n        \"maxCallPerCallee\": 5\n    }\n]\n\n

Update Bot Configuration

This endpoint allows the user to update the configuration settings for a specific bot.

Request

Method: PUT
\n
Endpoint: api.asklabai.com/botCs/{botId}
\n

{\n    \"botId\": String,\n    \"voiceId\": String,\n    \"fromNumber\": String,\n    \"emailReport\": String,\n    \"gSheetId\": String,\n    \"ownerId\": String,\n    \"useCaseId\": String,\n    \"active\": Boolean,\n    \"replicas\": Integer,\n    \"maxCallPerCallee\": Integer\n}\n

Response example

The response is in JSON format and represents the updated configuration settings for the bot. Below is a JSON schema representing the response:

{\n    \"botId\": \"6735da5073bf4936985e59f1\",\n    \"voiceId\": \"JKPWJfiNeucVg6ncekqY\",\n    \"fromNumber\": \"+33700000000\",\n    \"emailReport\": \"edit@askartefact.com\",\n    \"gSheetId\": \"13bKHVs30CmMnfUve4JPSgem0\",\n    \"ownerId\": \"66d872917e7dba64646c2fd4\",\n    \"useCaseId\": \"6717b239a6a7d92ae9d9fc1a\",\n    \"active\": false,\n    \"replicas\": 1,\n    \"maxCallPerCallee\": 2\n}\n\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"xi-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"1bad8524-c2e6-4f9a-9002-fdb3fc2ade0b","id":"1bad8524-c2e6-4f9a-9002-fdb3fc2ade0b","name":"Documentation Ask Lab Api","type":"collection"}},"urlObject":{"path":["botCs","{botId}"],"host":["api.asklabai.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6403bedb-9a53-4d51-8854-a7ab516e5721"}],"id":"0f1506a1-c98b-4597-b2af-375c386d723a","_postman_id":"0f1506a1-c98b-4597-b2af-375c386d723a","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"xi-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"1bad8524-c2e6-4f9a-9002-fdb3fc2ade0b","id":"1bad8524-c2e6-4f9a-9002-fdb3fc2ade0b","name":"Documentation Ask Lab Api","type":"collection"}}},{"name":"UseCase","item":[{"name":"Create use case","id":"62762d4b-e28f-4dd5-9790-a60661cb86cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"description\" : \"Demo Artefact API\",\n \"name\": \"artefact_api\",\n \"context\" : \"Contexte\\r\\nVous \\u00EAtes L\\u00E9a, une conseill\\u00E8re intelligente cr\\u00E9\\u00E9e par Artefact, sp\\u00E9cialis\\u00E9e en intelligence artificielle. Engagez des \\u00E9changes dynamiques et pertinents dans le cadre d'une conversation t\\u00E9l\\u00E9phonique. Vous initiez toujours l'appel. Adoptez une approche empathique et persuasive pour d\\u00E9couvrir les besoins du prospect, en \\u00E9coutant attentivement et en personnalisant votre discours. Si le client ne souhaite pas discuter, tentez de le convaincre. Ne faites jamais de liste num\\u00E9rot\\u00E9e dans vos r\\u00E9ponses. N'utilisez pas d'abr\\u00E9viations dans vos r\\u00E9ponses. Commencez toujours vos r\\u00E9ponses par une phrase de sept mots maximum puis d\\u00E9veloppez bri\\u00E8vement votre argumentation. Si vous ne comprenez pas la phrase du client ou si elle n'est pas coh\\u00E9rente, dites que vous n\\u2019avez pas compris et demandez-lui de r\\u00E9p\\u00E9ter.\\r\\n\\r\\nObjectif\\r\\nAppelez le prospect afin de d\\u00E9couvrir ses probl\\u00E9matiques sp\\u00E9cifiques et proposez des solutions adapt\\u00E9es offertes par Artefact, qui cr\\u00E9e des bots utilisant l'intelligence artificielle pour r\\u00E9pondre \\u00E0 diverses probl\\u00E9matiques. Assurez-vous de bien comprendre et conna\\u00EEtre le secteur d'activit\\u00E9 du prospect.\\r\\n\\r\\nFlux d'Appel\\r\\nPr\\u00E9sentez-vous et expliquez l'objectif de l'appel, appelez le prospect par son pr\\u00E9nom.\\r\\nExpliquez que vous \\u00EAtes un bot cr\\u00E9\\u00E9 par Artefact utilisant l'intelligence artificielle.\\r\\nDemandez au prospect de parler de son secteur d'activit\\u00E9 et des besoins ou challenges actuels qu'il rencontre.\\r\\nExplorez les solutions personnalis\\u00E9es offertes par Artefact pour r\\u00E9pondre \\u00E0 ses besoins sp\\u00E9cifiques.\\r\\n\\r\\nDialogue d'Exemple\\r\\nVous : Bonjour [Nom du prospect]! Je suis L\\u00E9a, une conseill\\u00E8re cr\\u00E9\\u00E9e par Artefacte. Comment allez-vous aujourd\\u2019hui ?\\r\\n\\r\\nPersonne : Bonjour L\\u00E9a, oui \\u00E7a va.\\r\\n\\r\\nVous : Parfait [Nom du prospect] ! Puis-je vous prendre quelques instants pour discuter de vos besoins actuels et voir comment Artefact peut vous aider avec des solutions utilisant l'intelligence artificielle ?\\r\\n\\r\\nPersonne : Pourquoi pas.\\r\\n\\r\\nVous : Super, je vais vous poser quelques questions rapides.\\r\\n\\r\\nPersonne : Entendu.\\r\\n\\r\\nVous : Pouvez-vous me parler de votre secteur d'activit\\u00E9 et des besoins ou des challenges que vous rencontrez actuellement ?\\r\\n\\r\\nPersonne : Nous travaillons dans le secteur de la vente au d\\u00E9tail et nous avons besoin de plus de commerciaux pour g\\u00E9rer les appels entrants.\\r\\n\\r\\nVous : Je comprends. Pouvez-vous m'en dire plus sur les d\\u00E9fis sp\\u00E9cifiques que vous rencontrez dans ce domaine ?\\r\\n\\r\\nPersonne : Nous avons du mal \\u00E0 trouver des commerciaux qualifi\\u00E9s et disponibles.\\r\\n\\r\\nVous : Merci pour cette pr\\u00E9cision. Chez Artefact, nous proposons des bots utilisant l'intelligence artificielle capables de g\\u00E9rer efficacement les appels et d'autres t\\u00E2ches pour soutenir votre \\u00E9quipe de vente. Pensez-vous que cela pourrait r\\u00E9pondre \\u00E0 vos besoins ?\\r\\n\\r\\nPersonne : Oui, cela m'int\\u00E9resse.\\r\\n\\r\\nVous : Parfait, si vous avez des questions, vous pouvez nous joindre au 06 20 29 23 86. Merci encore et bonne journ\\u00E9e !\\r\\n\\r\\nPersonne : Merci, au revoir !\",\n \"endingContext\" : \"1. R\\u00E9ception des \\u00E9changes :\\r\\n - Vous allez envoyer tous les \\u00E9changes d'une conversation t\\u00E9l\\u00E9phonique entre un utilisateur et un assistant.\\r\\n\\r\\n2. Cr\\u00E9ation du JSON :\\r\\n - Le syst\\u00E8me analysera la conversation et cr\\u00E9era un fichier JSON contenant deux attributs.\\r\\n\\r\\n3. Attributs du JSON :\\r\\n\\r\\n - \\\"status\\\" (type : int) :\\r\\n - 1 : Si un rendez-vous a \\u00E9t\\u00E9 pris avec le prospect.\\r\\n - 2 : Si le prospect est disqualifi\\u00E9, c'est-\\u00E0-dire qu'il a exprim\\u00E9 un d\\u00E9sint\\u00E9r\\u00EAt pour le service propos\\u00E9.\\r\\n - 0 : Si le syst\\u00E8me ne dispose pas d'assez d'informations pour trancher ou en cas de doute.\\r\\n\\r\\n - \\\"emailBody\\\" (type : string) :\\r\\n - Cet attribut doit contenir un r\\u00E9sum\\u00E9 clair et d\\u00E9taill\\u00E9 de l'\\u00E9change t\\u00E9l\\u00E9phonique suivant le format ci-apr\\u00E8s :\\r\\n\\r\\n ```\\r\\n R\\u00E9sum\\u00E9 de la conversation \\uD83D\\uDCAC : [R\\u00E9sum\\u00E9 de la conversation]\\r\\n Date et heure du rendez-vous \\uD83D\\uDCC6 : [Date et heure du rendez-vous]\\r\\n ```\\r\\n\\r\\n4. Processus d'analyse :\\r\\n\\r\\n - Le syst\\u00E8me doit lire et analyser chaque \\u00E9change de la conversation pour d\\u00E9terminer le statut du prospect et les d\\u00E9tails du rendez-vous.\\r\\n - Utiliser des algorithmes de traitement du langage naturel (NLP) pour identifier les phrases cl\\u00E9s indiquant la prise de rendez-vous, le d\\u00E9sint\\u00E9r\\u00EAt ou le manque d'information.\\r\\n\\r\\n5. Consignes de pr\\u00E9cision :\\r\\n - Le syst\\u00E8me ne doit jamais inventer des informations.\\r\\n - En cas de manque d'information, le statut doit \\u00EAtre d\\u00E9fini \\u00E0 0.\\r\\n - Le r\\u00E9sum\\u00E9 doit \\u00EAtre bas\\u00E9 uniquement sur les informations fournies dans les \\u00E9changes.\\r\\n - Assurer la clart\\u00E9 et la concision du r\\u00E9sum\\u00E9.\\r\\n - Il est imp\\u00E9ratif que ta r\\u00E9ponse ne contienne que le json non format\\u00E9, sans saut de ligne\\r\\n\\r\\n6. Exemple de JSON g\\u00E9n\\u00E9r\\u00E9 :\\r\\n\\r\\n {\\r\\n \\\"status\\\": 1,\\r\\n \\\"emailBody\\\": \\\"R\\u00E9sum\\u00E9 de la conversation \\uD83D\\uDCAC : Le prospect est int\\u00E9ress\\u00E9 par le service et a accept\\u00E9 de fixer un rendez-vous. Date et heure du rendez-vous \\uD83D\\uDCC6 : 2024-07-01 \\u00E0 15h00.\\\"\\r\\n }\",\n \"greetingStr\": \"Bonjour, je suis Léa de Artefact. Puis-je vous prendre quelques instants pour discuter de vos besoins actuels et voir comment Artefact peut vous aider avec des solutions utilisant l'intelligence artificielle ?\",\n \"alloStr\" : \"Allo. Bonjour\"\n}","options":{"raw":{"language":"json"}}},"url":"api.asklabai.com/useCase","description":"

POST /useCase

This endpoint allows the creation of a use case with the provided details.

Request Body

description (string): A brief description of the use case.
\n
name (string): The name of the use case.
\n
context (string): The context of the use case that will be used by the bot during the call flow.
\n
endingContext (string):
The context used at the end of the call used to rule the lead (qualified/disqualified) and launch actions
\n
greetingStr (string): The first sentence the bot will say after a callee has spoken
\n
alloStr (string): The few words the callee will hear when he picks up the call
\n

Response

Status: 200
\n
Content-Type: text/plain
\n
Body: useCaseId for the newly created use case
\n

The GET request to /useCase endpoint retrieves a list of use case objects belonging to your user. The response is a JSON array containing use case objects with the following properties:

id (string): The unique identifier of the use case.
\n
ownerId (string): The identifier of the owner of the use case.
\n
description (string): A description of the use case.
\n
name (string): The name of the use case.
\n
context (string): The context of the use case.
\n
endingContext (string): The ending context of the use case.
\n
greetingStr (string): The greeting string associated with the use case.
\n
alloStr (string): The allo string associated with the use case.
\n

This response can be documented as a JSON schema for the use case object.

Retrieve Use Case Details

This endpoint retrieves the details of a specific use case based on the provided useCaseId.

Request

Method: GET
\n
URL: api.asklabai.com/useCase/{useCaseId}
\n

Response

The response is in JSON format and has the following schema:

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"id\": {\n      \"type\": \"string\"\n    },\n    \"ownerId\": {\n      \"type\": \"string\"\n    },\n    \"description\": {\n      \"type\": \"string\"\n    },\n    \"name\": {\n      \"type\": \"string\"\n    },\n    \"context\": {\n      \"type\": \"string\"\n    },\n    \"endingContext\": {\n      \"type\": \"string\"\n    },\n    \"greetingStr\": {\n      \"type\": \"string\"\n    },\n    \"alloStr\": {\n      \"type\": \"string\"\n    }\n  }\n}\n\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"xi-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"1bad8524-c2e6-4f9a-9002-fdb3fc2ade0b","id":"1bad8524-c2e6-4f9a-9002-fdb3fc2ade0b","name":"Documentation Ask Lab Api","type":"collection"}},"urlObject":{"path":["useCase","{useCaseId}"],"host":["api.asklabai.com"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[],"_postman_id":"7c8ddf0d-cc21-412a-a601-aee8e5488d62"},{"name":"Edit use case","id":"61dcdcea-c77a-4a6c-a0f9-3662dc3e89fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"6735dd8573bf4936985e59f2\",\n \"ownerId\": \"66d872917e7dba64646c2fd4\",\n \"description\": \"Demo Artefact API Edited\",\n \"name\": \"artefact_api\",\n \"context\": \"Contexte\\r\\nVous êtes Léa, une conseillère intelligente créée par Artefact, spécialisée en intelligence artificielle. Engagez des échanges dynamiques et pertinents dans le cadre d'une conversation téléphonique. Vous initiez toujours l'appel. Adoptez une approche empathique et persuasive pour découvrir les besoins du prospect, en écoutant attentivement et en personnalisant votre discours. Si le client ne souhaite pas discuter, tentez de le convaincre. Ne faites jamais de liste numérotée dans vos réponses. N'utilisez pas d'abréviations dans vos réponses. Commencez toujours vos réponses par une phrase de sept mots maximum puis développez brièvement votre argumentation. Si vous ne comprenez pas la phrase du client ou si elle n'est pas cohérente, dites que vous n’avez pas compris et demandez-lui de répéter.\\r\\n\\r\\nObjectif\\r\\nAppelez le prospect afin de découvrir ses problématiques spécifiques et proposez des solutions adaptées offertes par Artefact, qui crée des bots utilisant l'intelligence artificielle pour répondre à diverses problématiques. Assurez-vous de bien comprendre et connaître le secteur d'activité du prospect.\\r\\n\\r\\nFlux d'Appel\\r\\nPrésentez-vous et expliquez l'objectif de l'appel, appelez le prospect par son prénom.\\r\\nExpliquez que vous êtes un bot créé par Artefact utilisant l'intelligence artificielle.\\r\\nDemandez au prospect de parler de son secteur d'activité et des besoins ou challenges actuels qu'il rencontre.\\r\\nExplorez les solutions personnalisées offertes par Artefact pour répondre à ses besoins spécifiques.\\r\\n\\r\\nDialogue d'Exemple\\r\\nVous : Bonjour [Nom du prospect]! Je suis Léa, une conseillère créée par Artefacte. Comment allez-vous aujourd’hui ?\\r\\n\\r\\nPersonne : Bonjour Léa, oui ça va.\\r\\n\\r\\nVous : Parfait [Nom du prospect] ! Puis-je vous prendre quelques instants pour discuter de vos besoins actuels et voir comment Artefact peut vous aider avec des solutions utilisant l'intelligence artificielle ?\\r\\n\\r\\nPersonne : Pourquoi pas.\\r\\n\\r\\nVous : Super, je vais vous poser quelques questions rapides.\\r\\n\\r\\nPersonne : Entendu.\\r\\n\\r\\nVous : Pouvez-vous me parler de votre secteur d'activité et des besoins ou des challenges que vous rencontrez actuellement ?\\r\\n\\r\\nPersonne : Nous travaillons dans le secteur de la vente au détail et nous avons besoin de plus de commerciaux pour gérer les appels entrants.\\r\\n\\r\\nVous : Je comprends. Pouvez-vous m'en dire plus sur les défis spécifiques que vous rencontrez dans ce domaine ?\\r\\n\\r\\nPersonne : Nous avons du mal à trouver des commerciaux qualifiés et disponibles.\\r\\n\\r\\nVous : Merci pour cette précision. Chez Artefact, nous proposons des bots utilisant l'intelligence artificielle capables de gérer efficacement les appels et d'autres tâches pour soutenir votre équipe de vente. Pensez-vous que cela pourrait répondre à vos besoins ?\\r\\n\\r\\nPersonne : Oui, cela m'intéresse.\\r\\n\\r\\nVous : Parfait, si vous avez des questions, vous pouvez nous joindre au 06 20 29 23 86. Merci encore et bonne journée !\\r\\n\\r\\nPersonne : Merci, au revoir !\",\n \"endingContext\": \"1. Réception des échanges :\\r\\n - Vous allez envoyer tous les échanges d'une conversation téléphonique entre un utilisateur et un assistant.\\r\\n\\r\\n2. Création du JSON :\\r\\n - Le système analysera la conversation et créera un fichier JSON contenant deux attributs.\\r\\n\\r\\n3. Attributs du JSON :\\r\\n\\r\\n - \\\"status\\\" (type : int) :\\r\\n - 1 : Si un rendez-vous a été pris avec le prospect.\\r\\n - 2 : Si le prospect est disqualifié, c'est-à-dire qu'il a exprimé un désintérêt pour le service proposé.\\r\\n - 0 : Si le système ne dispose pas d'assez d'informations pour trancher ou en cas de doute.\\r\\n\\r\\n - \\\"emailBody\\\" (type : string) :\\r\\n - Cet attribut doit contenir un résumé clair et détaillé de l'échange téléphonique suivant le format ci-après :\\r\\n\\r\\n ```\\r\\n Résumé de la conversation 💬 : [Résumé de la conversation]\\r\\n Date et heure du rendez-vous 📆 : [Date et heure du rendez-vous]\\r\\n ```\\r\\n\\r\\n4. Processus d'analyse :\\r\\n\\r\\n - Le système doit lire et analyser chaque échange de la conversation pour déterminer le statut du prospect et les détails du rendez-vous.\\r\\n - Utiliser des algorithmes de traitement du langage naturel (NLP) pour identifier les phrases clés indiquant la prise de rendez-vous, le désintérêt ou le manque d'information.\\r\\n\\r\\n5. Consignes de précision :\\r\\n - Le système ne doit jamais inventer des informations.\\r\\n - En cas de manque d'information, le statut doit être défini à 0.\\r\\n - Le résumé doit être basé uniquement sur les informations fournies dans les échanges.\\r\\n - Assurer la clarté et la concision du résumé.\\r\\n - Il est impératif que ta réponse ne contienne que le json non formaté, sans saut de ligne\\r\\n\\r\\n6. Exemple de JSON généré :\\r\\n\\r\\n {\\r\\n \\\"status\\\": 1,\\r\\n \\\"emailBody\\\": \\\"Résumé de la conversation 💬 : Le prospect est intéressé par le service et a accepté de fixer un rendez-vous. Date et heure du rendez-vous 📆 : 2024-07-01 à 15h00.\\\"\\r\\n }\",\n \"greetingStr\": \"Bonjour, je suis Léa de Artefact. Puis-je vous prendre quelques instants pour discuter de vos besoins actuels et voir comment Artefact peut vous aider avec des solutions utilisant l'intelligence artificielle ?\",\n \"alloStr\": \"Allo. Salut\",\n \"noListenTimeAtCallStart\": 0\n}","options":{"raw":{"language":"json"}}},"url":"api.asklabai.com/useCase/{useCaseId}","description":"

Update Use Case

This endpoint is used to update a specific use case by providing the use case ID in the URL path.

Request Body

id (string): The ID of the use case.
\n
ownerId (string): The ID of the owner.
\n
description (string): The updated description of the use case.
\n
name (string): The updated name of the use case.
\n
context (string): The updated context of the use case.
\n
endingContext (string): The updated ending context of the use case.
\n
greetingStr (string): The updated greeting string for the use case.
\n
alloStr (string): The updated allo string for the use case.
\n
noListenTimeAtCallStart (integer): The updated no listen time at call start.
\n

Response

Status: 200
\n
Content-Type: text/json
\n
Edited useCase
\n

POST /callee

This endpoint is used to create a new callee

Request Body

phoneNumber (text, required): The phone number of the callee.
\n
botId (text, required): The ID of the bot that will call the callee.
\n
- firstName (text, required): The first name of the callee.
\n
lastName (text, required): The last name of the callee.
\n
address (text, required): The address of the callee.
\n
postalCode (text, required): The postal code of the callee's address.
\n
city (text, required): The city of the callee's address.
\n
campain (text, not required): campain associated with this callee
\n

Response

The response is a JSON schema representing the ID of the submitted caller information.

Your CSV file

\n","value":null}]},"url":"api.asklabai.com/callee/csv/{botId}/{campainName}","description":"

Endpoint Description

This HTTP POST request is used to upload a CSV file for a specific bot and campaign to the designated endpoint.

Request

The request should include a CSV file to be uploaded as a form-data parameter with the key \"file\". The file should be of type \"file\".

botId (path parameter): The ID of the bot for which the CSV file is being uploaded.
\n
campaignName (path parameter): The name of the campaign for which the CSV file is being uploaded.
\n

Response

Upon successful execution, the response will have a status code of 200 and a return in the body the number of callees successfully created

The API endpoint sends an HTTP DELETE request to invalidate callees to a specific campaign associated with a bot. The request should be made to api.asklabai.com/callee/{botId}/{campainName}.

This request make stop calling the specified bot to callees with that campainName

The response returned from the last execution has a status code of 200

Get Call Recording

This endpoint retrieves the recording of a specific call identified by the callId.

Request

Method: GET
\n
URL: api.asklabai.com/call/{callId}/recording
\n

Response

The response will include the recording data for the specified call.

Endpoint Description

This endpoint retrieves the transcript associated with a specific call identified by its unique identifier.

Request

Method: GET
\n
URL: api.asklabai.com/call/{callId}/transcript
\n
Path Parameter:
\n
- callId (string): The unique identifier for the call whose transcript is being requested. In this example, it is 56fbb249-15fc-48fe-ac3c-77aa623ca5e4.
\n

Response

Status: 200 OK
\n
Content-Type: text/plain
\n
Response Body:
\n
- The response will return a JSON array containing objects with the following keys:
  \n
  - content (string): The text content of the transcript.
    \n
  - role (string): The role of the speaker (e.g., user, agent).
    \n
  - timeStamp (string): The time at which the content was spoken.
    \n
  \n
\n

Notes

The response will provide an array of transcript entries, each representing a segment of the conversation.
\n
Ensure that the callId is valid to receive the appropriate transcript data.
\n