Skip to content

API description

Gautier Darchen edited this page Jan 11, 2018 · 16 revisions

Les différents endpoints de notre API sont :

  • /dialog/create
  • /dialog/{id}/add

/dialog/create

  • Méthode : POST
  • Body : JSON
{
  "text": "la 1ère réplique de l'utilisateur",
}
  • Description : Crée un nouveau dialogue et y ajoute une 1ère réplique de l'utilisateur. Retourne l'id du dialogue créé et la réponse de l'agent à cette réplique.Si tous les paramètres sont réunis, alors on renvoie :
{
  "sessionId": "sessionId",
  "text": "la réponse de l'agent",
  "confirm": true,
  "type": "action",
  "action": {
    "type": "alarm",
    "datetime": "YYYY-MM-dd HH:mm:ss"
  },
  "error": true|false,
}

S'il manque un ou plus parametres :

{
  "sessionId": "sessionId",
  "type": "text",
  "text": "la réponse de l'agent",
  "confirm": false,
  "error": true|false,
}

/dialog/{id}/add

  • Méthode : PUT
  • parametres: "sessionId": "l'id du dialogue"
  • Body : JSON
{
  "text": "une nouvelle réplique"
}
  • Description : Ajoute une nouvelle réplique à un dialogue. Retourne la réponse de l'agent à cette réplique.
  • Réponse : JSON

Si tous les paramètres sont réunis, alors on renvoie :

{
  "sessionId": "sessionId",
  "text": "la réponse de l'agent",
  "confirm": true,
  "type": "action",
  "action": {
    "type": "alarm",
    "datetime": "YYYY-MM-dd HH:mm:ss"
  },
  "error": true|false,
}

S'il manque un ou plus parametres :

{
  "sessionId": "sessionId",
  "type": "text",
  "text": "la réponse de l'agent",
  "confirm": false,
  "error": true|false,
}
Clone this wiki locally