{"type":"doc","content":[{"type":"heading","attrs":{"level":2},"content":[{"text":"Introduction","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Basic Working","type":"text"}]},{"type":"paragraph","content":[{"text":"Pause/resume service expects a post request with the extension of an agent. After receiving the request it makes a connection with freeswitch using ESL(Event Socket Lib). It run a command “show calls” and retrieve all the calls active at that time. A command using ","type":"text"}]},{"type":"codeBlock","content":[{"text":"uuid_broadcast uuid record_session_mask::${record_path}/${recording_filename} both","type":"text"}]},{"type":"paragraph","content":[{"text":" will be sent to mask the call","type":"text"}]},{"type":"paragraph","content":[{"text":"The call will be paused in a sense that it would be masked and that portion will be muted. An as soon as the call is unmasked it will be recording once again. ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":604,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":604,"alt":"image-20241104-053630.png","id":"bfb0fbb4-6a6a-483a-9a57-1c0ce3bfe15e","collection":"contentId-977731594","type":"file","height":120}}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Architecture","type":"text"}]},{"type":"paragraph","content":[{"text":"Inside Apis we have two end point in the controller that handles pause and resume request. With pause and resume service we have an ESL service responsible for the connection making and handling. Inside Pause and resume service we have two major functions one is to mask and other is to umask. These functions are dependent on esl connection for fetching call information and also on another function that extract all the useful information from the response and help masking or unmasking a call. ","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"drawio","parameters":{"macroParams":{"mVer":{"value":"2"},"zoom":{"value":"1"},"simple":{"value":"0"},"inComment":{"value":"0"},"custContentId":{"value":"645529665"},"pageId":{"value":"638550052"},"lbox":{"value":"1"},"diagramDisplayName":{"value":"pauseandResume.drawio"},"contentVer":{"value":"1"},"revision":{"value":"1"},"baseUrl":{"value":"https://expertflow-docs.atlassian.net/wiki"},"diagramName":{"value":"pauseandResume.drawio"},"pCenter":{"value":"0"},"width":{"value":"681"},"links":{"value":""},"tbstyle":{"value":""},"height":{"value":"560.5"}},"macroMetadata":{"macroId":{"value":"9ed32136-f1f2-4bd8-b81d-213eb3eef9e4"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"image","data":{"url":"https://ac.draw.io/connectImage?mVer=2&zoom=1&simple=0&inComment=0&custContentId=645529665&pageId=638550052&lbox=1&diagramDisplayName=pauseandResume.drawio&contentVer=1&revision=1&baseUrl=https%3A%2F%2Fexpertflow-docs.atlassian.net%2Fwiki&diagramName=pauseandResume.drawio&pCenter=0&width=681&links=&tbstyle=&height=560.5"}}],"title":"draw.io Diagram"}},"localId":"e171fecf-f77f-4324-bf4a-e2219b06e099"}},{"type":"paragraph"},{"type":"heading","attrs":{"level":2},"content":[{"text":"ESL connection","type":"text"}]},{"type":"paragraph","content":[{"text":"To Connect to FreeSwitch CLI we use the ESL(Event Socket Layer) libraries, It helps make connections with the free-switch using host, port, and password. Once the connection is established it fetches all the information from free-switch and also it gives commands to free-switch. ","type":"text"}]},{"type":"codeBlock","content":[{"text":"public class EslService {\n private String eslHost = System.getenv(\"ESL_HOST\");\n private int eslPort = Integer.parseInt(System.getenv(\"ESL_PORT\"));\n private String eslPassword = System.getenv(\"ESL_PASSWORD\");\n private Client inboundClient;\n private String recordingPath = System.getenv(\"REC_PATH_STREAMS\");\n\n public EslService() throws InboundConnectionFailure {\n inboundClient = new Client();\n inboundClient.connect(new InetSocketAddress(eslHost, eslPort), eslPassword, 10);\n log.debug(\"ESL Connection established\");\n }\n \n ...","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":2},"content":[{"text":"Configuration","type":"text"}]},{"type":"paragraph","content":[{"text":"In Pom.xml we need to add the following dependencies.","type":"text"}]},{"type":"codeBlock","content":[{"text":" \n esl-client\n esl-client\n 1.0\n compile\n \n\n \n io.netty\n netty-all\n 4.0.56.Final\n \n \n ...","type":"text"}]},{"type":"paragraph","content":[{"text":"We need further env variables ","type":"text"}]},{"type":"codeBlock","content":[{"text":"ESL_HOST = where the freeswitch is up and running\nESL_PORT = ESL makes connection with 8021 \nESL_PASSWORD = Password of the freeswitch","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":2},"content":[{"text":"Update the Lua script","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Go to the /usr/share/freeswitch/scripts/ ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Find the file with the name ","type":"text"},{"text":"set_recording_name.lua ","type":"text","marks":[{"type":"strong"}]},{"text":" script file","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"look for a line in the script ","type":"text"},{"text":"session:setVariable(\"recording_filename\" , agent_leg_uuid .. \".\" .. ext) ","type":"text","marks":[{"type":"strong"}]},{"text":"and update it to ","type":"text"},{"text":"session:setVariable(\"recording_filename\" , customer_leg_uuid .. \".\" .. ext)","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Here is the full lua script as a reference. it is very crucial for Pause/Resume of Call recording.","type":"text"}]},{"type":"codeBlock","content":[{"text":"package.cpath =\"/usr/lib/x86_64-linux-gnu/lua/5.2/?.so;\" .. package.cpath\npackage.path = \"/usr/share/lua/5.2/?.lua;\" .. package.path\n\nlocal callType = session:getVariable(\"sip_h_X-CallType\")\nlocal record_path = session:getVariable(\"record_path\")\nlocal uuid = session:getVariable(\"uuid\")\nlocal ext = session:getVariable(\"record_ext\")\nlocal customer_leg_uuid = ''\nlocal api = freeswitch.API();\n\n-- can be consult, OUT, MONITOR, PROGRESSIVE, \n\nlocal function fileExists(file) \n local f = io.open(record_path .. '/' .. file, 'r')\n if f == nil then\n -- freeswitch.consoleLog(\"ERROR\", \"set_recording_name.lua FILE NOT FOUND: \" .. file)\n return false;\n end\n io.close(f);\n -- freeswitch.consoleLog(\"ERROR\", \"set_recording_name.lua FILE WAS FOUND: \" .. file)\n return true;\nend\n\nlocal destination = tostring(session:getVariable(\"destination_number\"))\n-- freeswitch.consoleLog(\"NOTICE\", \" \\n set_recording_name.lua DESTINATION \\n \" .. destination)\n\n\nif (callType == \"CONSULT\") then \n freeswitch.consoleLog(\"NOTICE\", \" \\n set_recording_name.lua RECORDING CONSULT CALL \\n\")\n session:execute(\"stop_record_session\",\"all\")\n if (string.match(tostring(destination), \"99887766\")) then\n return\n end\n local filename = uuid .. \".\" .. ext\n session:setVariable(\"recording_command\" , \"nolocal:execute_on_answer=record_session \" .. record_path .. \"/\" .. filename)\n session:setVariable(\"recording_filename\" , filename)\n return\nelseif (callType == \"MONITOR\") then -- no recording enabled here\n return\n -- callType == \"PROGRESSIVE\" or \nelseif (callType == \"OUT\") then -- for manual outbound use the preset other leg uuid i.e. customer leg uuid\n\n customer_leg_uuid = session:getVariable(\"customer_leg_uuid\")\n freeswitch.consoleLog(\"NOTICE\", \" \\n set_recording_name.lua UUID \\n \" .. uuid)\n freeswitch.consoleLog(\"NOTICE\", \" \\n set_recording_name.lua CUSTOMER \\n\" .. customer_leg_uuid)\n if (uuid ~= customer_leg_uuid) then\n freeswitch.consoleLog(\"NOTICE\", \" \\n set_recording_name.lua RECORDING MANUAL OUTBOUND CALL \\n\")\n session:setVariable(\"recording_command\" , \"nolocal:execute_on_answer=record_session \" .. record_path .. \"/\" .. customer_leg_uuid .. \".\" .. ext)\n\tsession:setVariable(\"recording_filename\" , customer_leg_uuid .. \".\" .. ext)\n return\n end\n session:execute(\"stop_record_session\",\"all\")\n local res = api:executeString(\"bgapi uuid_broadcast \" .. uuid .. \" stop_record_session::all\")\n uuid = customer_leg_uuid\nend\n\nlocal filename = uuid\n-- inbound ivr case\nfreeswitch.consoleLog(\"NOTICE\", \"\\n set_recording_name.lua RECORDING INBOUND CALL \\n\")\nlocal count = 0\nwhile (fileExists(filename .. '.' .. ext)) do\n count = count + 1\n filename = uuid .. '_' .. count\nend\n\nlocal suffix = '_' .. count\nif (count == 0) then \n suffix = ''\nend\n\nfilename = uuid .. suffix.. \".\" .. ext\nsession:setVariable(\"recording_filename\" , filename)\nsession:setVariable(\"recording_command\" , \"nolocal:execute_on_answer=record_session \" .. record_path .. \"/\" .. filename)\n\n","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"ESL connection on Free-switch","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Go to /etc/freeswitch/autoload_configs/event_socket.conf.xml and add the following lines","type":"text"}]}]},{"type":"listItem","content":[{"type":"codeBlock","content":[{"text":"\n \n \n \n \n","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Go to /etc/freeswitch/autoload_config/acl.conf.xml and add the following lines","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":" \n \n ","type":"text"}]},{"type":"orderedList","attrs":{"order":2},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Type ‘fs_cli’ on your terminal it will open free-switch CLI and then run this command ‘reloadxml’ in fs_cli","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Type ‘fs_cli’ on your terminal it will open free-switch CLI and then run this command ‘reloadacl’ in fs_cli","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Restart the freeswitch using ","type":"text"},{"text":"sudo systemctl restart freeswitch","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"run ./install-efcx script to restart the vrs.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Controller end","type":"text"}]},{"type":"paragraph","content":[{"text":"We have two different APIs for pause and resume. Both of them awaits a post request containing extension of the customer. Then end point are as follows","type":"text"}]},{"type":"codeBlock","content":[{"text":"//For masking the call\nhttp://localhost:8080/vrs/recording/{extension}/pause\n\n//For unmasking the call\nhttp://localhost:8080/vrs/recording/{extension}/resume","type":"text"}]},{"type":"paragraph"}],"version":1}