{"info":{"_postman_id":"e50c1b1e-8fab-493c-b16f-9929d2f97ab8","name":"Documentation: Conversation Public Api (English)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"4107739","collectionId":"e50c1b1e-8fab-493c-b16f-9929d2f97ab8","publishedId":"S17oyqaY","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-03-19T19:27:06.000Z"},"item":[{"name":"Complements","item":[{"name":"Frequently Asked Questions (FAQs)","id":"72ff5368-e3c7-412e-a8f0-b978d982d4a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Token","value":"TXpFd1pETTRObVpsWXpZMlltRTBNakptTnpjM09HRTFNVE5rWVRBek16QQ=="}],"body":{"mode":"raw","raw":"{\n \"sentence\": \"hola\",\n \"user\": {\n \"hash\" : \"hash\",\n \"name\" : \"john\",\n \"lastname\" : \"doe\",\n \"email\" : \"john_doe@mail.com\"\n }\n}"},"url":"https://gateway.aivo.co/api/v1/conversation/messages","description":"

Faqs complement.

Allows to add related questions or intentions to an answer, this questions must be previously added to the platform. \nIt is allowed to incorporate questions related to an answer, which correspond to questions that must be previously loaded in the platform. The maximum allowed number of questions is 10.

Buttons.

Allows to add a button with a link or a question within the virtual assistant. The user can choose the button type, title and action to be executed. In the case of a link type button, it is validated that it be loaded with url format (http / https). It is possible to choose if the button opens the url in the same window (link \\ _self) or in a new one (link \\ _blank)

\n","urlObject":{"protocol":"https","path":["api","v1","conversation","messages"],"host":["gateway","aivo","co"],"query":[],"variable":[]}},"response":[{"id":"0b10b314-c238-48bc-9b65-4aceceb2f1a2","name":"Ejemplo de Botones","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Token","value":"TXpFd1pETTRObVpsWXpZMlltRTBNakptTnpjM09HRTFNVE5rWVRBek16QQ=="},{"key":"Authorization","value":"Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuaWNrbmFtZSI6IjE0NyIsIm5hbWUiOiIxNDcgQXBpIFB1YmxpYyBEZXYgRGVtbyIsInBpY3R1cmUiOiJodHRwczovL3MuZ3JhdmF0YXIuY29tL2F2YXRhci8xNmFkZjQxODI3MjhhZmViNTY3ODNkNTllOWQxNmEzMz9zPTQ4MCZyPXBnJmQ9aHR0cHMlM0ElMkYlMkZjZG4uYXV0aDAuY29tJTJGYXZhdGFycyUyRjFhLnBuZyIsInVwZGF0ZWRfYXQiOiIyMDE4LTA4LTEwVDE1OjM2OjI4LjM5MFoiLCJlbWFpbCI6IjE0N0AxNDcuY29tIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJpc3MiOiJodHRwczovL2Fpdm90ZXN0LmF1dGgwLmNvbS8iLCJzdWIiOiJhdXRoMHw1YjYzMWNhYTRlYTRkOTI5ZjYxYTY3YTkiLCJhdWQiOiJNdElpcGxFS2pOMVVDcVdpeUY4RWxtaXNYSmdDTllNbSIsImlhdCI6MTUzMzkxNTM4OCwiZXhwIjoxNTMzOTUxMzg4fQ.EIPQ0dlsNLQxW33aLpLstio3bj0x8qF5VNQAFCURr7Y"}],"body":{"mode":"raw","raw":"{\n \"sentence\": \"botones\",\n \"user\": {\n \"hash\" : \"hash\",\n \"name\" : \"john\",\n \"lastname\" : \"doe\",\n \"email\" : \"john_doe@mail.com\"\n }\n}"},"url":"https://gateway.aivo.co/api/v1/conversation/messages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"294","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Wed, 25 Jul 2018 18:17:15 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Werkzeug/0.14.1 Python/3.5.2","name":"Server","description":"A name for the server"}],"cookie":[],"responseTime":null,"body":"{\n \"complements\": [\n {\n \"action\": \"buttons\",\n \"param\": [\n {\n \"label\": \"Soy un boton\",\n \"type\": \"link\",\n \"value\": \"https://www.google.com.ar/\"\n }\n ]\n }\n ],\n \"text\": \"\",\n \"text_clean\": \"\",\n \"timestamp\": 1532542635.479\n}"},{"id":"2e4ef874-adb8-4cf1-811b-f4e905f91ea9","name":"Ejemplo de botones multiples","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Token","value":"TXpFd1pETTRObVpsWXpZMlltRTBNakptTnpjM09HRTFNVE5rWVRBek16QQ=="},{"key":"Authorization","value":"Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuaWNrbmFtZSI6IjE0NyIsIm5hbWUiOiIxNDcgQXBpIFB1YmxpYyBEZXYgRGVtbyIsInBpY3R1cmUiOiJodHRwczovL3MuZ3JhdmF0YXIuY29tL2F2YXRhci8xNmFkZjQxODI3MjhhZmViNTY3ODNkNTllOWQxNmEzMz9zPTQ4MCZyPXBnJmQ9aHR0cHMlM0ElMkYlMkZjZG4uYXV0aDAuY29tJTJGYXZhdGFycyUyRjFhLnBuZyIsInVwZGF0ZWRfYXQiOiIyMDE4LTA4LTEwVDE1OjM2OjI4LjM5MFoiLCJlbWFpbCI6IjE0N0AxNDcuY29tIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJpc3MiOiJodHRwczovL2Fpdm90ZXN0LmF1dGgwLmNvbS8iLCJzdWIiOiJhdXRoMHw1YjYzMWNhYTRlYTRkOTI5ZjYxYTY3YTkiLCJhdWQiOiJNdElpcGxFS2pOMVVDcVdpeUY4RWxtaXNYSmdDTllNbSIsImlhdCI6MTUzMzkxNTM4OCwiZXhwIjoxNTMzOTUxMzg4fQ.EIPQ0dlsNLQxW33aLpLstio3bj0x8qF5VNQAFCURr7Y"}],"body":{"mode":"raw","raw":"{\n \"sentence\": \"botones\",\n \"user\": {\n \"hash\" : \"hash\",\n \"name\" : \"john\",\n \"lastname\" : \"doe\",\n \"email\" : \"john_doe@mail.com\"\n }\n}"},"url":"https://gateway.aivo.co/api/v1/conversation/messages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"532","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Wed, 25 Jul 2018 20:17:33 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Werkzeug/0.14.1 Python/3.5.2","name":"Server","description":"A name for the server"}],"cookie":[],"responseTime":null,"body":"{\n \"complements\": [\n {\n \"action\": \"buttons\",\n \"param\": [\n {\n \"label\": \"cumple feliz\",\n \"type\": \"message\",\n \"value\": \"cumple feliz\"\n },\n {\n \"label\": \"value distinto\",\n \"type\": \"message\",\n \"value\": \"prueba repetidas\"\n },\n {\n \"label\": \"link\",\n \"type\": \"link\",\n \"value\": \"https://aivo.co\"\n }\n ]\n }\n ],\n \"text\": \"\",\n \"text_clean\": \"\",\n \"timestamp\": 1532549853.157\n}"}],"_postman_id":"db5bfb67-ea0d-4a11-a415-96bdd1180004"},{"name":"Carousel","id":"e1aa70da-b9bd-4607-8274-0a91c2c97cb5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Token","value":"TXpFd1pETTRObVpsWXpZMlltRTBNakptTnpjM09HRTFNVE5rWVRBek16QQ=="}],"body":{"mode":"raw","raw":"{\n \"sentence\": \"carousel\",\n \"user\": {\n \"hash\" : \"hash\",\n \"name\" : \"john\",\n \"lastname\" : \"doe\",\n \"email\" : \"john_doe@mail.com\"\n }\n}"},"url":"https://gateway.aivo.co/api/v1/conversation/messages","description":"

Carousel complement.

This complements generates a image gallery along with buttons like a carousel.

Emotions complement.

Emotions that can be passed to the avatar (if available) to force a reaction.

Feeling
\\r\\nFeeling
\\r\\n

\\r\\n\", \n \"text_clean\": \"Feeling\\nFeeling\\n\\u00a0\\r\\n\", \n \"timestamp\": 1532546965.4495\n}\n"}],"_postman_id":"d9faf054-6ef7-4425-97d3-1a08cb984723"},{"name":"Video","id":"a12992d5-2f35-46ee-ab3d-59e17e78e0cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Token","value":"TXpFd1pETTRObVpsWXpZMlltRTBNakptTnpjM09HRTFNVE5rWVRBek16QQ=="}],"body":{"mode":"raw","raw":"{\n \"sentence\": \"video\",\n \"user\": {\n \"hash\" : \"hash\",\n \"name\" : \"john\",\n \"lastname\" : \"doe\",\n \"email\" : \"john_doe@mail.com\"\n }\n}"},"url":"https://gateway.aivo.co/api/v1/conversation/messages","description":"

Video complement.

Add a video complement using a youtube url.

Image complement.

This complement returns an image link, and a reference id to position the image when markers are available in text like {ref:xxxx}

\n","urlObject":{"protocol":"https","path":["api","v1","conversation","messages"],"host":["gateway","aivo","co"],"query":[],"variable":[]}},"response":[{"id":"23e83555-1d51-4623-9415-18af9b1b0e36","name":"Ejemplo Imagen Multiple","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Token","value":"TXpFd1pETTRObVpsWXpZMlltRTBNakptTnpjM09HRTFNVE5rWVRBek16QQ=="},{"key":"Authorization","value":"Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuaWNrbmFtZSI6IjE0NyIsIm5hbWUiOiIxNDcgQXBpIFB1YmxpYyBEZXYgRGVtbyIsInBpY3R1cmUiOiJodHRwczovL3MuZ3JhdmF0YXIuY29tL2F2YXRhci8xNmFkZjQxODI3MjhhZmViNTY3ODNkNTllOWQxNmEzMz9zPTQ4MCZyPXBnJmQ9aHR0cHMlM0ElMkYlMkZjZG4uYXV0aDAuY29tJTJGYXZhdGFycyUyRjFhLnBuZyIsInVwZGF0ZWRfYXQiOiIyMDE4LTA4LTEwVDE1OjM2OjI4LjM5MFoiLCJlbWFpbCI6IjE0N0AxNDcuY29tIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJpc3MiOiJodHRwczovL2Fpdm90ZXN0LmF1dGgwLmNvbS8iLCJzdWIiOiJhdXRoMHw1YjYzMWNhYTRlYTRkOTI5ZjYxYTY3YTkiLCJhdWQiOiJNdElpcGxFS2pOMVVDcVdpeUY4RWxtaXNYSmdDTllNbSIsImlhdCI6MTUzMzkxNTM4OCwiZXhwIjoxNTMzOTUxMzg4fQ.EIPQ0dlsNLQxW33aLpLstio3bj0x8qF5VNQAFCURr7Y"}],"body":{"mode":"raw","raw":"{\n \"sentence\": \"imagen vg\",\n \"user\": {\n \"hash\" : \"hash\",\n \"name\" : \"john\",\n \"lastname\" : \"doe\",\n \"email\" : \"john_doe@mail.com\"\n }\n}"},"url":"https://gateway.aivo.co/api/v1/conversation/messages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"668","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Wed, 25 Jul 2018 19:44:11 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Werkzeug/0.14.1 Python/3.5.2","name":"Server","description":"A name for the server"}],"cookie":[],"responseTime":null,"body":"{\n \"complements\": [\n {\n \"action\": \"image\",\n \"link\": null,\n \"param\": \"https://s3.amazonaws.com/agentbot/1000/answer-3b790d837814df3ac32367e93ededd2f1513093940.png\",\n \"ref\": \"1295b58d30b23fda\"\n },\n {\n \"action\": \"image\",\n \"link\": null,\n \"param\": \"https://s3.amazonaws.com/agentbot/1000/answer-3b790d837814df3ac32367e93ededd2f1513093940.png\",\n \"ref\": \"5385b58d30b243e6\"\n }\n ],\n \"text\": \"imagen 1
\\r\\n{ref:1295b58d30b23fda}
\\r\\n
\\r\\nimagen 2
\\r\\n{ref:5385b58d30b243e6}\",\n \"text_clean\": \"imagen 1\\n{ref:1295b58d30b23fda}\\n\\nimagen 2\\n{ref:5385b58d30b243e6}\",\n \"timestamp\": 1532547851.2974\n}"},{"id":"9b2922cf-1d43-4e6b-9707-5144ac58b1e2","name":"Ejemplo Imagen","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Token","value":"TXpFd1pETTRObVpsWXpZMlltRTBNakptTnpjM09HRTFNVE5rWVRBek16QQ=="},{"key":"Authorization","value":"Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuaWNrbmFtZSI6IjE0NyIsIm5hbWUiOiIxNDcgQXBpIFB1YmxpYyBEZXYgRGVtbyIsInBpY3R1cmUiOiJodHRwczovL3MuZ3JhdmF0YXIuY29tL2F2YXRhci8xNmFkZjQxODI3MjhhZmViNTY3ODNkNTllOWQxNmEzMz9zPTQ4MCZyPXBnJmQ9aHR0cHMlM0ElMkYlMkZjZG4uYXV0aDAuY29tJTJGYXZhdGFycyUyRjFhLnBuZyIsInVwZGF0ZWRfYXQiOiIyMDE4LTA4LTEwVDE1OjM2OjI4LjM5MFoiLCJlbWFpbCI6IjE0N0AxNDcuY29tIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJpc3MiOiJodHRwczovL2Fpdm90ZXN0LmF1dGgwLmNvbS8iLCJzdWIiOiJhdXRoMHw1YjYzMWNhYTRlYTRkOTI5ZjYxYTY3YTkiLCJhdWQiOiJNdElpcGxFS2pOMVVDcVdpeUY4RWxtaXNYSmdDTllNbSIsImlhdCI6MTUzMzkxNTM4OCwiZXhwIjoxNTMzOTUxMzg4fQ.EIPQ0dlsNLQxW33aLpLstio3bj0x8qF5VNQAFCURr7Y"}],"body":{"mode":"raw","raw":"{\n \"sentence\": \"imagen\",\n \"user\": {\n \"hash\" : \"hash\",\n \"name\" : \"john\",\n \"lastname\" : \"doe\",\n \"email\" : \"john_doe@mail.com\"\n }\n}"},"url":"https://gateway.aivo.co/api/v1/conversation/messages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"343","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Wed, 25 Jul 2018 19:37:38 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Werkzeug/0.14.1 Python/3.5.2","name":"Server","description":"A name for the server"}],"cookie":[],"responseTime":null,"body":"{\n \"complements\": [\n {\n \"action\": \"image\",\n \"link\": \"http://site.com/reference_text\",\n \"param\": \"https://s3.amazonaws.com/agentbot/1000/answer-9d8dd1e22c073f1b6da98b797e1da7601520541345.jpg\",\n \"ref\": \"7815b58d1820c679\"\n }\n ],\n \"text\": \"{ref:7815b58d1820c679}\",\n \"text_clean\": \"{ref:7815b58d1820c679}\",\n \"timestamp\": 1532547458.1787\n}"}],"_postman_id":"5bd47f94-8333-47bf-97d0-7b22d465bc91"},{"name":"Iframe","id":"5585d719-378c-4f3a-be05-ea2ca3eb4677","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Token","value":"TXpFd1pETTRObVpsWXpZMlltRTBNakptTnpjM09HRTFNVE5rWVRBek16QQ=="}],"body":{"mode":"raw","raw":"{\n \"sentence\": \"iframe\",\n \"user\": {\n \"hash\" : \"hash\",\n \"name\" : \"john\",\n \"lastname\" : \"doe\",\n \"email\" : \"john_doe@mail.com\"\n }\n}"},"url":"https://gateway.aivo.co/api/v1/conversation/messages","description":"

Iframe complement.

It loads an url inside an iframe to show more information if necessary.

Allows custom integrations to connect third party services.

Headers

Authorization: Bearer token obtained from Auth endpoint.
X-Token Channel X-Token. (Obtained from Aivo)

Parameters

sentence : sentence for call the external URL.
user
hash : unique identifier, string, required.
name : client's name, string, required.
lastname : client's last name, string, required.
email : client's email, string, required.

The following documentation describes the add-ons or complements that can be sent along the answers. These complements are functionalities (buttons, images, carousels, etc.) that are separated from the response itself, to optimize the interaction of users with the virtual assistant.

The complements are grouped in the \"complements\" array and unlimited complements of different types can be combined within the same response. For example, there may be 2 image complements (as detailed in the complement documentation)

\n","event":[{"listen":"prerequest","script":{"id":"02f329fe-90e1-49ea-9c05-d29fe70ea43e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"072143b4-cdb6-4aba-8f84-28ab171e95c1","type":"text/javascript","exec":[""]}}],"_postman_id":"90edbc72-66e3-4e82-968b-c2c4c3ff9d6d"},{"name":"Help API","item":[{"name":"Tags","item":[{"name":"Get all tags","id":"eac09a05-6e14-4448-8cab-726107539173","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Token","value":"T0RGbU1HSXdskdNeE9EVTROek5rTXpZM016WTFOMk13WVdZeE56WT0="},{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuaWNrbmFtZSI6ImJhcmRpbGVzIiwibmFtZSI6IkJyaWFuIEFyZGlsZXMiLCJwaWN0dXJlIjoiaHR0cHM6Ly9zLmdyYXZhdGFyLmNvbS9hdmF0YXIvMjZjZGMwNWU1MmM2Nzk2ZmVmYzQ0Zjk2ODZjOWEzNzk_cz00OD..."}],"url":"https://gateway.aivo.co/api/v1/help/tags","urlObject":{"protocol":"https","path":["api","v1","help","tags"],"host":["gateway","aivo","co"],"query":[],"variable":[]}},"response":[{"id":"433e2327-e51e-4069-aff4-9cf14b9dbf76","name":"Get all tags","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Token","value":"T0RGbU1HSXdZamswTkdNeE9EVTROek5rTXpZM016WTFOMk13WVdZeE56WT0="},{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuaWNrbmFtZSI6ImJhcmRpbGVzIiwibmFtZSI6IkJyaWFuIEFyZGlsZXMiLCJwaWN0dXJlIjoiaHR0cHM6Ly9zLmdyYXZhdGFyLmNvbS9hdmF0YXIvMjZjZGMwNWU1MmM2Nzk2ZmVmYzQ0Zjk2ODZjOWEzNzk_cz00OD..."}],"url":"https://gateway.aivo.co/api/v1/help/tags"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[{\n\t\"articles\": [{\n\t\t\"created_at\": \"1567087279\",\n\t\t\"id\": \"70787\",\n\t\t\"name\": \"article title\",\n\t\t\"updated_at\": null\n\t}],\n\t\"children\": [{\n\t\t\t\"id\": \"1241\",\n\t\t\t\"name\": \"children article title\"\n\t\t},\n\t\t{\n\t\t\t\"id\": \"4566\",\n\t\t\t\"name\": \"children article two\"\n\t\t}\n\t],\n\t\"id\": \"3782\",\n\t\"name\": \"tag name\"\n}]"}],"_postman_id":"eac09a05-6e14-4448-8cab-726107539173"},{"name":"Get one tag by id","id":"520bfd35-658d-4572-ad76-c642ef60ef20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Token","value":"T0RGbU1HSXdskdNeE9EVTROek5rTXpZM016WTFOMk13WVdZeE56WT0="},{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuaWNrbmFtZSI6ImJhcmRpbGVzIiwibmFtZSI6IkJyaWFuIEFyZGlsZXMiLCJwaWN0dXJlIjoiaHR0cHM6Ly9zLmdyYXZhdGFyLmNvbS9hdmF0YXIvMjZjZGMwNWU1MmM2Nzk2ZmVmYzQ0Zjk2ODZjOWEzNzk_cz00OD..."}],"url":"https://gateway.aivo.co/api/v1/help/tags/1241","urlObject":{"protocol":"https","path":["api","v1","help","tags","1241"],"host":["gateway","aivo","co"],"query":[],"variable":[]}},"response":[{"id":"de89845e-f3d6-4213-b6f6-f3fb359434ef","name":"Get one tag by id","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Token","value":"T0RGbU1HSXdZamswTkdNeE9EVTROek5rTXpZM016WTFOMk13WVdZeE56WT0="},{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuaWNrbmFtZSI6ImJhcmRpbGVzIiwibmFtZSI6IkJyaWFuIEFyZGlsZXMiLCJwaWN0dXJlIjoiaHR0cHM6Ly9zLmdyYXZhdGFyLmNvbS9hdmF0YXIvMjZjZGMwNWU1MmM2Nzk2ZmVmYzQ0Zjk2ODZjOWEzNzk_cz00OD..."}],"url":"https://gateway.aivo.co/api/v1/help/tags/1241"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"articles\": [\n {\n \"created_at\": \"1567087279\",\n \"id\": \"70787\",\n \"name\": \"article title 1\",\n \"updated_at\": null\n },\n {\n \"created_at\": \"1567087279\",\n \"id\": \"71383\",\n \"name\": \"article title 2\",\n \"updated_at\": null\n }\n ],\n \"children\": [],\n \"id\": \"1241\",\n \"name\": \"tag title\",\n \"parent\": [\n {\n \"id\": \"3782\",\n \"name\": \"tag parent name\",\n \"parent\": []\n }\n ]\n }\n]"}],"_postman_id":"520bfd35-658d-4572-ad76-c642ef60ef20"}],"id":"b250afb7-3bca-4e31-92a6-ebc1977220bd","_postman_id":"b250afb7-3bca-4e31-92a6-ebc1977220bd","description":""},{"name":"Articles","item":[{"name":"Get frequents","id":"59d60452-2753-4fda-91e1-077181ae6b7b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Token","value":"T0RGbU1HSXdskdNeE9EVTROek5rTXpZM016WTFOMk13WVdZeE56WT0="},{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuaWNrbmFtZSI6ImJhcmRpbGVzIiwibmFtZSI6IkJyaWFuIEFyZGlsZXMiLCJwaWN0dXJlIjoiaHR0cHM6Ly9zLmdyYXZhdGFyLmNvbS9hdmF0YXIvMjZjZGMwNWU1MmM2Nzk2ZmVmYzQ0Zjk2ODZjOWEzNzk_cz00OD..."}],"url":"https://gateway.aivo.co/api/v1/help/frecuents","urlObject":{"protocol":"https","path":["api","v1","help","frecuents"],"host":["gateway","aivo","co"],"query":[],"variable":[]}},"response":[],"_postman_id":"59d60452-2753-4fda-91e1-077181ae6b7b"},{"name":"Search","id":"c0ff1217-c45b-4061-a6fd-98a7e402f270","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Token","value":"T0RGbU1HSXdskdNeE9EVTROek5rTXpZM016WTFOMk13WVdZeE56WT0="},{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuaWNrbmFtZSI6ImJhcmRpbGVzIiwibmFtZSI6IkJyaWFuIEFyZGlsZXMiLCJwaWN0dXJlIjoiaHR0cHM6Ly9zLmdyYXZhdGFyLmNvbS9hdmF0YXIvMjZjZGMwNWU1MmM2Nzk2ZmVmYzQ0Zjk2ODZjOWEzNzk_cz00OD..."}],"url":"https://gateway.aivo.co/api/v1/help/search?article=term to search&hash=unique identifier, string, required.","urlObject":{"protocol":"https","path":["api","v1","help","search"],"host":["gateway","aivo","co"],"query":[{"key":"article","value":"term to search"},{"key":"hash","value":"unique identifier, string, required."}],"variable":[]}},"response":[],"_postman_id":"c0ff1217-c45b-4061-a6fd-98a7e402f270"}],"id":"a99c3f4d-5bc2-479a-a1fe-9035dfa58558","_postman_id":"a99c3f4d-5bc2-479a-a1fe-9035dfa58558","description":""}],"id":"933352f5-b065-4ef3-b319-00eca13ea91c","_postman_id":"933352f5-b065-4ef3-b319-00eca13ea91c","description":""},{"name":"Whatsapp","item":[{"name":"Native Integration","item":[{"name":"Send templates","id":"dadaea21-20ef-4c8b-b77b-1807d69e6377","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuaWNrbmFtZSI6ImlkdXF1ZSIsIm5hbWUiOiJJc2FuZSBEdXF1ZSIsInBpY3R1cmUiOiJodHRwczovL3MuZ3JhdmF0YXIuY29tL2F2YXRhci85NGRlNWI3M2Q4ZTQ0ZjQwODU5ZDU1M2Y3Y2I3MmFlZ..","type":"text"},{"key":"X-Token","value":"WWpsaU5ETTRORGxtWk..","type":"text"}],"body":{"mode":"raw","raw":"{\n \"to\": \"wa-id\",\n \"type\": \"template\",\n \"template\": {\n \"namespace\": \"name_space\",\n \"name\": \"template_name\",\n \"language\": {\n \"policy\": \"deterministic\",\n \"code\": \"es_MX\"\n },\n \"components\": []\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://gateway.aivo.co/api/v1/conversation-whatsapp-native-templates","description":"

This endpoint allow send templates.\nFull template documentation: https://developers.facebook.com/docs/whatsapp/api/messages/message-templates/media-message-templates\n

\n Authorization: Bearer token obtained from Auth endpoint.
\n X-token: Channel X-Token. (Obtained from Aivo)
\n To: It is the number to whom you want to send the template
\n Namespace: This must be the namespace associated with the WhatsApp business account that owns the phone number associated with the current WhatsApp Business API client or the message will fail to send.
\n Name: It is the name of the template.
\n Code: It is the language of the template.

\n","urlObject":{"protocol":"https","path":["api","v1","conversation-whatsapp-native-templates"],"host":["gateway","aivo","co"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[],"_postman_id":"dadaea21-20ef-4c8b-b77b-1807d69e6377"}],"id":"2ca93b60-4145-4a0f-8eb2-73c4f43a2df1","_postman_id":"2ca93b60-4145-4a0f-8eb2-73c4f43a2df1","description":""}],"id":"f8ca9e98-179a-4a91-ada2-d02f9cfc2711","_postman_id":"f8ca9e98-179a-4a91-ada2-d02f9cfc2711","description":""},{"name":"Live Standalone","item":[{"name":"Queue Conversation","id":"8575ef79-d33d-4ea3-8e5d-2462a0b25fb2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Token","value":"TVdOaVlUTX..."},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cC.."}],"body":{"mode":"raw","raw":"{\n \"botId\": 5543,\n \"groupsId\": [\n 1000091\n ],\n \"botToken\": \"1cba33aa3721db0a5ceb201cf87a0e0e\",\n \"protocolId\": 28,\n \"user\": {\n \"hash\": \"b9e8f46b56efbacea7a6a4cdab3_71146a36682af3c0915577\",\n \"firstname\": \"Brian\",\n \"lastname\": null,\n \"email\": null,\n \"phone\": \"5492236638596\",\n \"username\": null,\n \"picture\": null,\n \"extra\": []\n },\n \"status\": \"queued\",\n \"lastSender\": \"user\"\n}"},"url":"https://gateway.aivo.co/api/v1/live-handler/queue/external","urlObject":{"protocol":"https","path":["api","v1","live-handler","queue","external"],"host":["gateway","aivo","co"],"query":[],"variable":[]}},"response":[],"_postman_id":"8575ef79-d33d-4ea3-8e5d-2462a0b25fb2"},{"name":"Send message to agent","id":"8816a04b-1a1c-4383-ac9c-376296946d9b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Token","value":"TVdOaVlUTXpZV...."},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Ik5VSTBRa0V4TmpZNU5rUTJOek5GUmpWRU1qQTBOMFU1UVRZelJUQkVSamhDUkRreU5ESXhOZyJ9.eyJodHRwczovL2hhc3VyYS5pby9qd3QvY2xhaW1zIjp7IngtaGFzdXJhLWRlZmF1bHQtcm9sZSI6InVzZXIiLCJ4LWhhc3VyYS1hbGxvd2VkLXJvbGVzIjpbInVzZXIiXSwieC1oYXN1cmEtdXNlci1pZCI6ImF1dGgwfDViMzI3MGYxZGVhNWM5NTkwMzRjYjE4MCJ9LCJuaWNrbmFtZSI6ImJhcmRpbGVzIiwibmFtZSI6IkJyaWFuIiwicGljdHVyZSI6Imh0dHBzOi8vcy5ncmF2YXRhci5jb20vYXZhdGFyLzI2Y2RjMDVlNTJjNjc5NmZlZmM0NGY5Njg2YzlhMzc5P3M9NDgwJnI9cGcmZD1odHRwcyUzQSUyRiUyRmNkbi5hdXRoMC5jb20lMkZhdmF0YXJzJTJGc2kucG5nIiwidXBkYXRlZF9hdCI6IjIwMjQtMDEtMzFUMTg6NTQ6MDguMDg..."}],"body":{"mode":"raw","raw":"{\n \"message\": [\n {\n \"action\": \"text\",\n \"value\": \"Hola, mi nombre es Tomas y necesito saber el saldo de mi cuenta.\",\n \"source\": \"user\"\n }\n ]\n}"},"url":"https://gateway.aivo.co/api/v1/live-handler/de0478b2-be1c-456d-b3e6-ff897b0b8629/client/message","urlObject":{"protocol":"https","path":["api","v1","live-handler","de0478b2-be1c-456d-b3e6-ff897b0b8629","client","message"],"host":["gateway","aivo","co"],"query":[],"variable":[]}},"response":[],"_postman_id":"8816a04b-1a1c-4383-ac9c-376296946d9b"}],"id":"b6ad6d36-77c1-4123-b2e4-f58b55555b3a","_postman_id":"b6ad6d36-77c1-4123-b2e4-f58b55555b3a","description":""},{"name":"Send Message","id":"6148386d-017b-47ca-afbe-4b8728515ff6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"X-Token","value":"TkRNNU56WmhOMlptTWpCbE9XUXpaRFl5TXpreFlqUTVZMlF6TWpneVlXVT0="}],"body":{"mode":"raw","raw":"{\n \"sentence\": \"hi\",\n \"user\": {\n \"hash\" : \"1a2b3c4g5h61a2b3c4g5h61a2b3c4g5h\",\n \"name\" : \"john\",\n \"lastname\" : \"doe\",\n \"email\" : \"john_doe@gmail.com\"\n }\n}"},"url":"https://gateway.aivo.co/api/v1/conversation/messages","description":"

Format for how to send a question to the bot

Headers

Authorization: Bearer token obtained from Auth endpoint.
X-Token Channel X-Token. (Obtained from Aivo)

Parameters

sentence : Sentence or intention that is sent to the bot, string, required.
user
hash : unique identifier, string, required.
name : client's name, string, required.
lastname : client's last name, string, required.
email : client's email, string, required.

\n","urlObject":{"protocol":"https","path":["api","v1","conversation","messages"],"host":["gateway","aivo","co"],"query":[],"variable":[]}},"response":[{"id":"fc12a3c6-3be0-45c0-811e-4d31254f3c64","name":"Send Message","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"X-Token","value":"TkRNNU56WmhOMlptTWpCbE9XUXpaRFl5TXpreFlqUTVZMlF6TWpneVlXVT0="},{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuaWNrbmFtZSI6Im1tZW5kb3phIiwibmFtZSI6Ik1heGltaWxpYW5vIE1lbmRvemEiLCJwaWN0dXJlIjoiaHR0cHM6Ly9zLmdyYXZhdGFyLmNvbS9hdmF0YXIv...","type":"text"}],"body":{"mode":"raw","raw":"{\n \"sentence\": \"hi\",\n \"user\": {\n \"hash\" : \"1a2b3c4g5h61a2b3c4g5h61a2b3c4g5h\",\n \"name\" : \"john\",\n \"lastname\" : \"doe\",\n \"email\" : \"john_doe@gmail.com\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://gateway.aivo.co/api/v1/conversation/messages"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"complements\": [],\n \"text\": \"Hello!! How are you?\",\n \"text_clean\": \"Hello!!\",\n \"timestamp\": 1535133678.3345\n}"}],"_postman_id":"6148386d-017b-47ca-afbe-4b8728515ff6"},{"name":"Close Conversation","id":"4500a050-00e9-414d-a64b-d7a4af1d2157","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Token","value":"TXpFd1pETTRObVpsWXpZMlltRTBNakptTnpjM09HRTFNVE5rWVRBek16QQ"}],"body":{"mode":"raw","raw":"{\n \"hash\" : \"1a2b3c4g5h61a2b3c4g5h61a2b3c4g5h\"\n}"},"url":"https://gateway.aivo.co/api/v1/conversation/events/close","description":"
Format for how to send a question to the bot
\n
\n
Parameters
\n
\n
hash : unique identifier, string, required.
\n
\n","urlObject":{"protocol":"https","path":["api","v1","conversation","events","close"],"host":["gateway","aivo","co"],"query":[],"variable":[]}},"response":[{"id":"328a2c93-a957-4e52-9345-7aaf9e352380","name":"Ejemplo de cerrado de conversacion","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Token","value":"TXpFd1pETTRObVpsWXpZMlltRTBNakptTnpjM09HRTFNVE5rWVRBek16QQ=="},{"key":"Authorization","value":"Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuaWNrbmFtZSI6IjE0NyIsIm5hbWUiOiIxNDcgQXBpIFB1YmxpYyBEZXYgRGVtbyIsInBpY3R1cmUiOiJodHRwczovL3MuZ3JhdmF0YXIuY29tL2F2YXRhci8xNmFkZjQxODI3MjhhZmViNTY3ODNkNTllOWQxNmEzMz9zPTQ4MCZyPXBnJmQ9aHR0cHMlM0ElMkYlMkZjZG4uYXV0aDAuY29tJTJGYXZhdGFycyUyRjFhLnBuZyIsInVwZGF0ZWRfYXQiOiIyMDE4LTA4LTEwVDE1OjM2OjI4LjM5MFoiLCJlbWFpbCI6IjE0N0AxNDcuY29tIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJpc3MiOiJodHRwczovL2Fpdm90ZXN0LmF1dGgwLmNvbS8iLCJzdWIiOiJhdXRoMHw1YjYzMWNhYTRlYTRkOTI5ZjYxYTY3YTkiLCJhdWQiOiJNdElpcGxFS2pOMVVDcVdpeUY4RWxtaXNYSmdDTllNbSIsImlhdCI6MTUzMzkxNTM4OCwiZXhwIjoxNTMzOTUxMzg4fQ.EIPQ0dlsNLQxW33aLpLstio3bj0x8qF5VNQAFCURr7Y"}],"body":{"mode":"raw","raw":"{\n\t\"user\" : \"jon_doe\",\n\t\"password\" : \"123456\"\n}"},"url":"https://gateway.aivo.co/api/v1/conversation/messages"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"340","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Wed, 25 Jul 2018 02:51:36 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Werkzeug/0.14.1 Python/3.5.2","name":"Server","description":"A name for the server"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"4500a050-00e9-414d-a64b-d7a4af1d2157"},{"name":"Auth","id":"abf39f18-b738-4abd-b49a-a94052b75e7e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Token","value":"TXpFd1pETTRObVpsWXpZMlltRTBNakptTnpjM09HRTFNVE5rWVRBek16QQ=="}],"body":{"mode":"raw","raw":"{\n\t\"user\" : \"user\",\n\t\"password\": \"12345678\"\n}"},"url":"https://gateway.aivo.co/api/v1/auth","description":"
Auth endpoint to obtain the bearer token needed in order to interact with the bot.
\n
Important: This bearer expires at 10 hours.
\n","urlObject":{"protocol":"https","path":["api","v1","auth"],"host":["gateway","aivo","co"],"query":[],"variable":[]}},"response":[{"id":"033e3326-8b39-4722-bc45-d77c3bf44d17","name":"Ejemplo de autenticacion","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Token","value":"TXpFd1pETTRObVpsWXpZMlltRTBNakptTnpjM09HRTFNVE5rWVRBek16QQ=="}],"body":{"mode":"raw","raw":"{\n\t\"user\" : \"jon_doe\",\n\t\"password\" : \"123456\"\n}"},"url":"https://gateway.aivo.co/api/v1/auth"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"676","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 24 Aug 2018 17:28:03 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Werkzeug/0.14.1 Python/3.5.2","name":"Server","description":"A name for the server"}],"cookie":[],"responseTime":null,"body":"{\n \"Authorization\": \"Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuaWNrbmFtZSI6IjE0NyIsIm5hbWUiOiIxNDcgQXBpIFB1YmxpYyBEZXYgRGVtbyIsInBpY3R1cmUiOiJodHRwczovL3MuZ3JhdmF0YXIuY29tL2F2YXRhci8xNmFkZjQxODI3MjhhZmViNTY3ODNkNTllOWQxNmEzMz9zPTQ4MCZyPXBnJmQ9aHR0cHMlM0ElMkYlMkZjZG4uYXV0aDAuY29tJTJGYXZhdGFycyUyRjFhLnBuZyIsInVwZGF0ZWRfYXQiOiIyMDE4LTA4LTI0VDE3OjI4OjAzLjU4NloiLCJlbWFpbCI6IjE0N0AxNDcuY29tIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJpc3MiOiJodHRwczovL2Fpdm90ZXN0LmF1dGgwLmNvbS8iLCJzdWIiOiJhdXRoMHw1YjYzMWNhYTRlYTRkOTI5ZjYxYTY3YTkiLCJhdWQiOiJNdElpcGxFS2pOMVVDcVdpeUY4RWxtaXNYSmdDTllNbSIsImlhdCI6MTUzNTEzMTY4MywiZXhwIjoxNTM1MTY3NjgzfQ.U4o5x4xzI3pSJiGfgMYW-6NLhPuGLsDbZEJVsafuGDc\"\n}\n"}],"_postman_id":"abf39f18-b738-4abd-b49a-a94052b75e7e"}],"event":[{"listen":"prerequest","script":{"id":"d6c80c16-c7b4-4d94-9903-c65d4933dc28","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"174f6f6a-f3d0-4537-aadd-b34bcab433e0","type":"text/javascript","exec":[""]}}]}