{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Through the API methods any CTLive integrator can send text messages, link or multimedia content, leave an active chat, terminate a chat for all participant.","type":"text"}]},{"type":"paragraph","content":[{"text":"Below we list all the available APIs related with a code example. The APIs are related to an istance of active chat, for example the same object returned by calling the ","type":"text"},{"text":"joinContact","type":"text","marks":[{"type":"link","attrs":{"href":"https://engitacontact.atlassian.net/wiki/spaces/CTLIVE/pages/92241921/Join+an+existing+chat"}}]},{"text":" method.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Send a Text message","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"ctlive_contact.sendMessage(\"Hello world!\").then(\n function (msgid) {\n console.log(\"Message sent\", msgid);\n }\n);","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Send a Multimedia message","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"/*\nSend a multimedia type message\ncontent object can be one of the following type:\n{ \n \"img\":\"\",\n \"caption\":\"\",\n \"fileName\": \"\",\n \"documentType\":\"\" (file extension JPG, JPEG, PNG.)\n}\n\n\n{ \n \"document\":\"\",\n \"caption\":\"\",\n \"fileName\": \"\",\n \"documentType\":\"\" (file extension PDF, DOC(X), PPT(X), XLS(X).)\n}\n*/\nctlive_contact.SendMultimediaMessage( \"DOCUMENT\", content).then(\n function (data) {\n console.log(\"Document message sent\", data);\n }\n);\n\n// Send an IMAGE type message (png/jpg/jpeg)\nctlive_contact.SendMultimediaMessage( \"IMAGE\", content).then(\n function (data) {\n console.log(\"Image message sent\", data);\n }\n);\n","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":3},"content":[{"text":"Get a Multimedia message","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"ctlive_contact.on(\"multimediaMessage\", \n function (event) {\n // Get multiemdia message content: call contact API GetMultimediaMessageInActiveChat(,)\n ctlive_contact.GetMultimediaMessageInActiveChat( ctlive_contact.contact.id, event.id).then(\n function (multimediaMessageObj) {\n console.log(\"multimedia message retrieved\", multimediaMessageObj);\n /*\n Example of multimedia object retrieved:\n {\n \"result\": true,\n \"data\": {\n \"chatID\": \"CHAT_DEFAULT_96387da2-3a5f-4d60-a30d-729e0e5706d8\",\n \"messageID\": \"a0458869-9747-4ab1-bd76-8727cf483685\",\n \"messageType\": \"IMAGE\",\n \"domain\": \"DEFAULT\",\n \"format\": \"fullsize\",\n \"content\": {\n \"img\": \"/9j/4AAQSkZJRgABA....\",\n \"caption\": \"myImage\",\n \"fileName\": \"45971097-illustrazione-di-happy-emoticon-dà-pollice-in-su-isolato-su-sfondo-bianco.jpg\",\n \"documentType\": \"jpg\",\n \"user\": {\n \"id\": \"USER_gverde1@acd.enghouse.com\",\n \"nickname\": \"Gabriele Verde\",\n \"isAgent\": true,\n \"beginTime\": 1584722203945,\n \"endTime\": \"\",\n \"isOnline\": true,\n \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/80.0.3987.132 Safari/537.36\",\n \"firstUri\": \"http://localhost:3003/AD/AD.html\",\n \"firstTitle\": \"AgentDesktop - Enghouse Interactive\",\n \"channel\": \"web\",\n \"firstIP\": \"::ffff:127.0.0.1\"\n }\n }\n },\n \"error\": null\n }\n \n \n {\n \"result\": true,\n \"data\": {\n \"chatID\": \"CHAT_DEFAULT_96387da2-3a5f-4d60-a30d-729e0e5706d8\",\n \"messageID\": \"9c45e6ce-e48f-4d55-beb3-6141ee2b1339\",\n \"messageType\": \"DOCUMENT\",\n \"domain\": \"DEFAULT\",\n \"format\": \"fullsize\",\n \"content\": {\n \"document\": \"JVBERi0xLjMNJeL.....\",\n \"caption\": \"myDoc\",\n \"fileName\": \"WhatsApp - omnichannel API quick guide.pdf\",\n \"documentType\": \"pdf\",\n \"user\": {\n \"id\": \"USER_gverde1@acd.enghouse.com\",\n \"nickname\": \"Gabriele Verde\",\n \"isAgent\": true,\n \"beginTime\": 1584722203945,\n \"endTime\": \"\",\n \"isOnline\": true,\n \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/80.0.3987.132 Safari/537.36\",\n \"firstUri\": \"http://localhost:3003/AD/AD.html\",\n \"firstTitle\": \"AgentDesktop - Enghouse Interactive\",\n \"channel\": \"web\",\n \"firstIP\": \"::ffff:127.0.0.1\"\n }\n }\n },\n \"error\": null\n }\n */\n }\n );\n });","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Send an Hyperlink message","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"ctlive_contact.SendLink(\"https://www.enghouseinteractive.it/\").then (\n function (msgid) {\n console.log(\"Hyperlink message sent\", msgid);\n }\n);\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Notifies “is writing” agent status","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"// The agent has started writing\nctlive_contact.isWriting(true);\n\n// The agent has stopped writing\nctlive_contact.isWriting(false);","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Terminate an active chat","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"// End a chat and disconnect all participant.\n// The instance of a CTLive active chat is specified as input parameter\nLIVECHATSDK.LIVECHAT.endContact(ctlive_contact);","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Leave an active chat","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"LIVECHATSDK.LIVECHAT.leave(\"CHAT_eaa2e7c0-9c26-40db-b720-d777ab68078d\");","type":"text"}]}],"version":1}

Browser not supported