{"info":{"_postman_id":"45897f1b-61a9-41ce-a9c9-258e8fd39739","name":"Mr Bot - Rosny sous Bois","description":"

Documentation de l'API Mr Bot pour le chatbot de la ville de Rosny-sous-Bois

\n
URI : https://rosny.mr-bot.fr/message
\n

Contacter Mr Bot pour obtenir un token \"mrbot-api-token\"

\n\n

Format de la réponse

L'API retourne un JSON composé de :

source_type : le type du message source
source : la valeur du message source (valeur du champ text ou payload passé lors de l'appel)
sender : bot
user_id : l'ID de l'utilisateur passé lors de l'appel
understood : valeur booléenne indiquant si la phrase a été comprise par le bot ou non : true|false
keywords : tableau de mots clés pour chaque intention déclenchée. keywords n'existe que quand le bot a été en mesure de comprendre la saisie de l'utilisateur.
messages : tableau de messages. Chaque message contient une clé type (text, carousel, image, quick_replies ou buttons) et une clé content

Exemple de réponse :

{\n    \"source_type\": \"text\",\n    \"source\": \"bonjour\",\n    \"sender\": \"bot\",\n    \"user_id\": \"123\",\n    \"understood\": true,\n    \"keywords\": [\n        \"bonjour\",\n        \"salut\"\n    ],\n    \"messages\": [\n        {\n            \"type\": \"text\",\n            \"content\": {\n                \"text_message\": \"Bonjour à vous cher habitant 🤭\"\n            }\n        }\n    ]\n}\n

\n\n

Requêtes d'exemple

\n\n

Exemples de requêtes pour obtenir les différents types de réponses :

Pour obtenir un type \"text\" : envoyer la chaine \"bonjour\"
Pour obtenir un type \"carousel\" : envoyer la chaine texte \"horaires de la mairie\"
Pour obtenir un type \"image\" : envoyer la chaine \"blabla\"
Pour obtenir un type \"quick_replies\" : envoyer la chaine \"blabla\"
Pour obtenir un type \"buttons\" : envoyer le payload \"get_buttons\"

Les \"buttons\" peuvent également prendre le type \"PhoneNumber\" (click to call)

Exemples de requêtes qui retournent des mots clés, si une phrase ne contient pas de mots clés, le nom de l'intention fait office de mots clés

\"où se garer\" : Plusieurs mots clés liés au zonage du stationnement
\"à quelle heure ouvre la mairie\" : Mots clés liés aux horaires de la mairie
\"adresse de la mairie\" : Le nom de l'intention est retourné dans keywords

Payload existants pour les types \"postback\" ou \"quick_reply\" (voir les exemples de requêtes) :

\"get_started\"
\"mail_maire\"
\"get_buttons\"

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"5269256","collectionId":"45897f1b-61a9-41ce-a9c9-258e8fd39739","publishedId":"RWgqUHvQ","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2018-11-21T20:33:58.000Z"},"item":[{"name":"SAP Queries","item":[{"name":"Dialog","id":"3272b218-0176-49fb-b177-c3363d92a773","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Token 42da6195a347ef71afb3fbfdfa47f128"}],"body":{"mode":"raw","raw":"{\n\t\"message\": \n\t{\n\t\t\"content\":\"qui est le maire\",\n\t\t\"type\":\"text\"\n\t\t\n\t}, \n\t\"conversation_id\": \"testmrbot\", \n\t\"language\": \"fr\"\n}"},"url":"https://api.cai.tools.sap/build/v1/dialog","urlObject":{"protocol":"https","path":["build","v1","dialog"],"host":["api","cai","tools","sap"],"query":[],"variable":[]}},"response":[],"_postman_id":"3272b218-0176-49fb-b177-c3363d92a773"}],"id":"57152af2-df81-4de7-bd8f-55280696d58f","_postman_id":"57152af2-df81-4de7-bd8f-55280696d58f","description":""},{"name":"Text","id":"7a456ea6-03d1-4ed0-a637-c993ab5d16bc","request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"mrbot-api-token","name":"Content-Type","value":"temp","type":"text"}],"body":{"mode":"raw","raw":"{\n \"user_id\": \"123\",\n \"type\": \"text\",\n \"message\":\n {\n \t\"text\": \"Bonjour\"\n }\n}"},"url":"https://rosny.mr-bot.fr/message","urlObject":{"protocol":"https","path":["message"],"host":["rosny","mr-bot","fr"],"query":[],"variable":[]}},"response":[],"_postman_id":"7a456ea6-03d1-4ed0-a637-c993ab5d16bc"},{"name":"Text Preprod","id":"3f4ca991-888a-41a6-9bef-956add561ed6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"},{"key":"mrbot-api-token","name":"Content-Type","type":"text","value":"ne3U5d5oDPwYvbWlBbnETnnjHLElVuZZ"}],"body":{"mode":"raw","raw":"{\n \"user_id\": \"123\",\n \"type\": \"text\",\n \"message\":\n {\n \t\"text\": \"Bonjour\"\n }\n}"},"url":"https://rosny.mr-bot.fr/message_preprod","urlObject":{"protocol":"https","path":["message_preprod"],"host":["rosny","mr-bot","fr"],"query":[],"variable":[]}},"response":[],"_postman_id":"3f4ca991-888a-41a6-9bef-956add561ed6"},{"name":"Postback","id":"68189103-bcee-4555-899d-fc37c03b23ac","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"mrbot-api-token","name":"Content-Type","type":"text","value":"temp"}],"body":{"mode":"raw","raw":"{\n \"user_id\": \"123\",\n \"type\": \"postback\",\n \"message\":\n {\n \t\"payload\": \"get_started\",\n \t\"title\": \"Démarrer\"\n }\n}"},"url":"https://rosny.mr-bot.fr/message","urlObject":{"protocol":"https","path":["message"],"host":["rosny","mr-bot","fr"],"query":[],"variable":[]}},"response":[{"id":"e4044c93-2107-4f0a-96cf-aa2de6238e6c","name":"Démarrer une conversation","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"mrbot-api-token","name":"Content-Type","type":"text","value":"temp"}],"body":{"mode":"raw","raw":"{\n \"user_id\": \"123\",\n \"type\": \"postback\",\n \"message\":\n {\n \t\"payload\": \"get_started\",\n \t\"title\": \"Démarrer\"\n }\n}"},"url":"https://rosny.mr-bot.fr/message"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 Mar 2019 14:34:33 GMT"},{"key":"Server","value":"Apache"},{"key":"Connection","value":"close"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"source_type\": \"postback\",\n \"source\": \"get_started\",\n \"sender\": \"bot\",\n \"user_id\": \"123\",\n \"messages\": [\n {\n \"type\": \"text\",\n \"content\": {\n \"text_message\": \"Bienvenue !\\nJe suis le bot de la ville de Rosny-sous-Bois 🙂\"\n }\n },\n {\n \"type\": \"text\",\n \"content\": {\n \"text_message\": \"Vous pouvez me parler directement, je m'efforcerai de vous répondre au mieux 😊\"\n }\n },\n {\n \"type\": \"text\",\n \"content\": {\n \"text\": \"Posez-moi directement vos questions, je peux vous aider notamment sur ces sujets 👇\",\n \"quick_replies\": [\n {\n \"title\": \"Nous contacter\",\n \"payload\": \"contact_mairie\"\n },\n {\n \"title\": \"Nous rejoindre\",\n \"payload\": \"mairie_recrutement\"\n },\n {\n \"title\": \"Mes démarches\",\n \"payload\": \"demarches\"\n },\n {\n \"title\": \"Portail familles\",\n \"payload\": \"portail_familles\"\n },\n {\n \"title\": \"Menus des cantines\",\n \"payload\": \"menus_cantine\"\n },\n {\n \"title\": \"Gestion des déchets\",\n \"payload\": \"dechets\"\n },\n {\n \"title\": \"Autre\",\n \"payload\": \"get_help_other\"\n }\n ],\n \"text_message\": \"Posez-moi directement vos questions, je peux vous aider notamment sur ces sujets 👇\"\n }\n }\n ]\n}"}],"_postman_id":"68189103-bcee-4555-899d-fc37c03b23ac"},{"name":"Quick Reply","id":"179a7aaa-9095-49af-89c5-bb283145b1db","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"mrbot-api-token","name":"Content-Type","type":"text","value":"temp"}],"body":{"mode":"raw","raw":"{\n \"user_id\": \"123\",\n \"type\": \"quick_reply\",\n \"message\":\n {\n \t\"payload\": \"get_started\",\n \t\"title\":\"Démarrer\"\n }\n}"},"url":"https://rosny.mr-bot.fr/message","urlObject":{"protocol":"https","path":["message"],"host":["rosny","mr-bot","fr"],"query":[],"variable":[]}},"response":[],"_postman_id":"179a7aaa-9095-49af-89c5-bb283145b1db"}],"event":[{"listen":"prerequest","script":{"id":"e3dbc7e9-544d-4117-bb27-59b46c4d5e47","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"fba4dfc8-9dd7-4805-ae4a-82aa16561051","type":"text/javascript","exec":[""]}}]}