{"id":16196,"date":"2021-09-14T12:32:15","date_gmt":"2021-09-14T16:32:15","guid":{"rendered":"https:\/\/www.collectionsmax.com\/index.php\/docs\/screenpop-web-service\/screen-pop-relay"},"modified":"2022-05-13T11:42:16","modified_gmt":"2022-05-13T15:42:16","slug":"screen-pop-relay","status":"publish","type":"docs","link":"https:\/\/www.collectionsmax.com\/index.php\/docs\/screenpop-web-service\/screen-pop-relay","title":{"rendered":"Screen Pop Relay"},"content":{"rendered":"<p><span style=\"color: #000000;\">Sometimes it is not possible for a dialer to send custom fields (like the collectionsmax.dbase.id) of the popped account to our screen pop webservice.\u00a0 When this happens a relay script needs to be used.<br \/>\n<\/span><\/p>\n<p><span style=\"color: #000000;\">With the screen pop relay the dialer sends the popped phone number to the relay script along with a few other possible parameters like userid and password (if you enabled password protection from inside the script).\u00a0 The script will query the phone number against the collectionsmax database and it will automatically relay the correct\u00a0 information to our screen pop server.<br \/>\n<\/span><\/p>\n<p><span style=\"color: #000000;\">Our PHP relay script is usually installed on a web server that is directly on the Collections MAX database server itself .\u00a0 An example of an easy to use web server would be something like the Abyss web server for Windows or the Apache web server for Linux.\u00a0 You can find tutorials on how to setup a PHP environment online using google.\u00a0 Please don&#8217;t try to put the script on a different server than the one with the database on it because you might endure a ton of latency.\u00a0 Latency is a term used to define a delay.\u00a0 And since we are already using two hops instead of one (dialer to relay to screen pop server) that delay can be substantial and can cause issues with the screen pop system.<\/span><\/p>\n<p><span style=\"color: #000000;\">Using this script with http is preferable over https as it will be faster due to no encryption overhead and there is very little sensitive information being passed to or from the screenpop webservice (the user id, the screenpop activation key you are using and the collectionsmax.dbase.id of the account).<br \/>\n<\/span><\/p>\n<p><span style=\"color: #000000;\">When using the relay it will be best to use the screen pop system in Normal mode since there will be added latency which will cause Auto mode to pop too late.<\/span><\/p>\n<p><span style=\"color: #000000;\">Configuration of the PHP relay script is done directly in the script itself and in the script you will find documentation on the settings.\u00a0 Requires PHP 7 and above.\u00a0 Tested with PHP 8.<br \/>\n<\/span><\/p>\n<p style=\"text-align: center;\"><a href=\"https:\/\/s3.amazonaws.com\/CollectionsMAXDownloads\/products\/collectionsmax\/screenpoprelay.zip\">You can download the Collections MAX Screen Pop Relay PHP script by clicking here.<\/a><\/p>\n","protected":false},"featured_media":0,"parent":1399,"menu_order":3,"comment_status":"open","ping_status":"closed","template":"","doc_tag":[],"comment_count":0,"_links":{"self":[{"href":"https:\/\/www.collectionsmax.com\/index.php\/wp-json\/wp\/v2\/docs\/16196"}],"collection":[{"href":"https:\/\/www.collectionsmax.com\/index.php\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/www.collectionsmax.com\/index.php\/wp-json\/wp\/v2\/types\/docs"}],"replies":[{"embeddable":true,"href":"https:\/\/www.collectionsmax.com\/index.php\/wp-json\/wp\/v2\/comments?post=16196"}],"version-history":[{"count":0,"href":"https:\/\/www.collectionsmax.com\/index.php\/wp-json\/wp\/v2\/docs\/16196\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/www.collectionsmax.com\/index.php\/wp-json\/wp\/v2\/docs\/1399"}],"next":[{"title":"TMAX Dialer Configuration","link":"https:\/\/www.collectionsmax.com\/index.php\/docs\/screenpop-web-service\/tmax-dialer-configuration","href":"https:\/\/www.collectionsmax.com\/index.php\/wp-json\/wp\/v2\/docs\/1631"}],"prev":[{"title":"Dialer URL","link":"https:\/\/www.collectionsmax.com\/index.php\/docs\/screenpop-web-service\/dialer-url","href":"https:\/\/www.collectionsmax.com\/index.php\/wp-json\/wp\/v2\/docs\/1624"}],"wp:attachment":[{"href":"https:\/\/www.collectionsmax.com\/index.php\/wp-json\/wp\/v2\/media?parent=16196"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/www.collectionsmax.com\/index.php\/wp-json\/wp\/v2\/doc_tag?post=16196"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}