[{"id":"4bcfd3b8-df96-95b6-72d4-de7753988243","label":"Summary","body":{"version":1,"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"Our developer API offers access to most functions available in the UI of the admin platform, and access to features before they are integrated into the UI."}]},{"type":"paragraph","content":[{"type":"text","text":"It also offers low-code/no-code integrations for integrating the functions of our platform into your own customer experience."}]},{"type":"paragraph","content":[{"type":"text","text":"API Documentation: "},{"type":"text","text":"Phonism API on Postman","marks":[{"type":"link","attrs":{"href":"https://documenter.getpostman.com/view/6160997/S1EWNuYj"}}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"type":"text","text":"{{url}}","marks":[{"type":"em"}]},{"type":"text","text":" mentioned in Postman is :"}]},{"type":"paragraph","content":[{"type":"text","text":" app.phonism.com/api/v3/"}]},{"type":"paragraph","content":[{"type":"text","text":"OR if you are using Whitelabeling:"}]},{"type":"paragraph","content":[{"type":"text","text":" {"},{"type":"text","text":"whitelabel admin portal domain}","marks":[{"type":"em"}]},{"type":"text","text":"/api/v3/"}]}]}]}},{"id":"702e279e-b03a-cbbf-8e4d-b751d3788cb8","label":"Configuration","body":{"version":1,"type":"doc","content":[{"type":"heading","attrs":{"level":2},"content":[{"type":"text","text":"Create API Key"}]},{"type":"paragraph","content":[{"type":"text","text":"You can create as many API keys as you wish, at multiple levels of your accounts hierarchy. API Keys always have access to anything below their hierarchy location in your account, but never above."}]},{"type":"orderedList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"text","text":"Navigate to the hierarchy location where you wish to create and API key"}]}]}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"type":"external","width":796,"height":85,"url":"https://phonism.atlassian.net/wiki/download/attachments/1469743197/22fc1602-6213-4c6a-bbe6-e1f69b02a3ed%20(1).png?version=1&modificationDate=1656939626014&cacheVersion=1&api=v2"}}]},{"type":"paragraph","content":[{"type":"text","text":"2. Click on "},{"type":"text","text":"“Integrations”","marks":[{"type":"strong"}]}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"type":"external","width":807,"height":167,"url":"https://phonism.atlassian.net/wiki/download/attachments/1469743197/ec0c3520-a83f-4049-8354-b6778b4d48c2%20(1).png?version=1&modificationDate=1656939681278&cacheVersion=1&api=v2"}}]},{"type":"paragraph","content":[{"type":"text","text":"3. Click on "},{"type":"text","text":"“Add New Integration”","marks":[{"type":"strong"}]}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"id":"att1469743204","type":"external","width":751,"height":309,"url":"https://phonism.atlassian.net/wiki/download/attachments/1469743197/ad0236ac-d452-4a2c-9000-713be3979dee.png?version=1&modificationDate=1655206235061&cacheVersion=1&api=v2"}}]},{"type":"paragraph","content":[{"type":"text","text":"4. Select "},{"type":"text","text":"“Generate your own API Key”","marks":[{"type":"strong"}]},{"type":"text","text":" in the "},{"type":"text","text":"“Type”","marks":[{"type":"strong"}]},{"type":"text","text":" dropdown. Fill out a name for the key, and click on "},{"type":"text","text":"“Generate”. ","marks":[{"type":"strong"}]}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"id":"att1470070897","type":"external","width":752,"height":308,"url":"https://phonism.atlassian.net/wiki/download/attachments/1469743197/4bb5b86c-1fde-49a5-8354-280eddb5f89f.png?version=1&modificationDate=1655206257399&cacheVersion=1&api=v2"}}]},{"type":"paragraph","content":[{"type":"text","text":"5. Click "},{"type":"text","text":"“Add”","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"type":"text","text":"You have now created an API key at your desired level of access in your account hierarchy."}]},{"type":"heading","attrs":{"level":2},"content":[{"type":"text","text":"Friendly Names Configuration"}]},{"type":"paragraph","content":[{"type":"text","text":"Config params can be mapped to aliases in the system to be used in API calls which is called friendly names. "}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"text","text":"You can get all the friendly names defined in the system with the following API call:"},{"type":"hardBreak"},{"type":"text","text":"Get Available Friendly Names","marks":[{"type":"link","attrs":{"href":"https://documenter.getpostman.com/view/6160997/S1EWNuYj#613ada6b-6ea0-43b4-b55a-8d4ddc5d5d73"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"text","text":"You can add a new friendly name to the system with the following API call:"},{"type":"hardBreak"},{"type":"text","text":"Add Friendly Name","marks":[{"type":"link","attrs":{"href":"https://documenter.getpostman.com/view/6160997/S1EWNuYj#8cdec894-9390-4681-964c-7af66766e496"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"text","text":"You can update the existing friendly name in the system with the following API call:"},{"type":"hardBreak"},{"type":"text","text":"Update Friendly Name","marks":[{"type":"link","attrs":{"href":"https://documenter.getpostman.com/view/6160997/S1EWNuYj#b715322d-de52-4828-9858-6de298433860"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"text","text":"You can delete the existing friendly name from the system with the following API call:"},{"type":"hardBreak"},{"type":"text","text":"Delete Friendly Name","marks":[{"type":"link","attrs":{"href":"https://documenter.getpostman.com/view/6160997/S1EWNuYj#b97e734e-67e8-4501-873e-38fda9ffc546"}}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"type":"text","text":"Default Friendly Names"}]},{"type":"paragraph","content":[{"type":"text","text":"Phonism has the following friendly names defined by default:"}]},{"type":"codeBlock","attrs":{},"content":[{"type":"text","text":"line.1.enable\r\nline.2.enable\r\nline.3.enable\r\nline.4.enable\r\nline.5.enable\r\nline.6.enable\r\nline.7.enable\r\nline.8.enable\r\nline.9.enable\r\nline.10.enable\r\nline.11.enable\r\nline.12.enable\r\nline.13.enable\r\nline.1.username\r\nline.2.username\r\nline.3.username\r\nline.4.username\r\nline.5.username\r\nline.6.username\r\nline.7.username\r\nline.8.username\r\nline.9.username\r\nline.10.username\r\nline.11.username\r\nline.12.username\r\nline.13.username\r\nline.1.authname\r\nline.2.authname\r\nline.3.authname\r\nline.4.authname\r\nline.5.authname\r\nline.6.authname\r\nline.7.authname\r\nline.8.authname\r\nline.9.authname\r\nline.10.authname\r\nline.11.authname\r\nline.12.authname\r\nline.13.authname\r\nline.1.password\r\nline.2.password\r\nline.3.password\r\nline.4.password\r\nline.5.password\r\nline.6.password\r\nline.7.password\r\nline.8.password\r\nline.9.password\r\nline.10.password\r\nline.11.password\r\nline.12.password\r\nline.13.password\r\nline.1.sipuri\r\nline.2.sipuri\r\nline.3.sipuri\r\nline.4.sipuri\r\nline.5.sipuri\r\nline.6.sipuri\r\nline.7.sipuri\r\nline.8.sipuri\r\nline.9.sipuri\r\nline.10.sipuri\r\nline.11.sipuri\r\nline.12.sipuri\r\nline.13.sipuri\r\nline.1.label\r\nline.2.label\r\nline.3.label\r\nline.4.label\r\nline.5.label\r\nline.6.label\r\nline.7.label\r\nline.8.label\r\nline.9.label\r\nline.10.label\r\nline.11.label\r\nline.12.label\r\nline.13.label\r\nline.1.displayname\r\nline.2.displayname\r\nline.3.displayname\r\nline.4.displayname\r\nline.5.displayname\r\nline.6.displayname\r\nline.7.displayname\r\nline.8.displayname\r\nline.9.displayname\r\nline.10.displayname\r\nline.11.displayname\r\nline.12.displayname\r\nline.13.displayname\r\nline.1.dialplan\r\nline.2.dialplan\r\nline.3.dialplan\r\nline.4.dialplan\r\nline.5.dialplan\r\nline.6.dialplan\r\nline.7.dialplan\r\nline.8.dialplan\r\nline.9.dialplan\r\nline.10.dialplan\r\nline.11.dialplan\r\nline.12.dialplan\r\nline.13.dialplan\r\nline.1.digitmap\r\nline.2.digitmap\r\nline.3.digitmap\r\nline.4.digitmap\r\nline.5.digitmap\r\nline.6.digitmap\r\nline.7.digitmap\r\nline.8.digitmap\r\nline.9.digitmap\r\nline.10.digitmap\r\nline.11.digitmap\r\nline.12.digitmap\r\nline.13.digitmap\r\nline.1.server.1.address\r\nline.2.server.1.address\r\nline.3.server.1.address\r\nline.4.server.1.address\r\nline.5.server.1.address\r\nline.6.server.1.address\r\nline.7.server.1.address\r\nline.8.server.1.address\r\nline.9.server.1.address\r\nline.10.server.1.address\r\nline.11.server.1.address\r\nline.12.server.1.address\r\nline.13.server.1.address\r\nline.1.server.1.port\r\nline.2.server.1.port\r\nline.3.server.1.port\r\nline.4.server.1.port\r\nline.5.server.1.port\r\nline.6.server.1.port\r\nline.7.server.1.port\r\nline.8.server.1.port\r\nline.9.server.1.port\r\nline.10.server.1.port\r\nline.11.server.1.port\r\nline.12.server.1.port\r\nline.13.server.1.port\r\nline.1.server.1.transport\r\nline.2.server.1.transport\r\nline.3.server.1.transport\r\nline.4.server.1.transport\r\nline.5.server.1.transport\r\nline.6.server.1.transport\r\nline.7.server.1.transport\r\nline.8.server.1.transport\r\nline.9.server.1.transport\r\nline.10.server.1.transport\r\nline.11.server.1.transport\r\nline.12.server.1.transport\r\nline.13.server.1.transport\r\nline.1.server.1.registration.address\r\nline.1.server.1.registration.port\r\nline.1.server.2.address\r\nline.2.server.2.address\r\nline.3.server.2.address\r\nline.4.server.2.address\r\nline.5.server.2.address\r\nline.6.server.2.address\r\nline.7.server.2.address\r\nline.8.server.2.address\r\nline.9.server.2.address\r\nline.10.server.2.address\r\nline.11.server.2.address\r\nline.12.server.2.address\r\nline.13.server.2.address\r\nline.1.server.2.port\r\nline.2.server.2.port\r\nline.3.server.2.port\r\nline.4.server.2.port\r\nline.5.server.2.port\r\nline.6.server.2.port\r\nline.7.server.2.port\r\nline.8.server.2.port\r\nline.9.server.2.port\r\nline.10.server.2.port\r\nline.11.server.2.port\r\nline.12.server.2.port\r\nline.13.server.2.port\r\nline.1.server.2.transport\r\nline.2.server.2.transport\r\nline.3.server.2.transport\r\nline.4.server.2.transport\r\nline.5.server.2.transport\r\nline.6.server.2.transport\r\nline.7.server.2.transport\r\nline.8.server.2.transport\r\nline.9.server.2.transport\r\nline.10.server.2.transport\r\nline.11.server.2.transport\r\nline.12.server.2.transport\r\nline.13.server.2.transport\r\nline.1.server.2.registration.address\r\nline.1.server.2.registration.port\r\nline.1.outboundproxy.1.enable\r\nline.2.outboundproxy.1.enable\r\nline.3.outboundproxy.1.enable\r\nline.4.outboundproxy.1.enable\r\nline.5.outboundproxy.1.enable\r\nline.6.outboundproxy.1.enable\r\nline.7.outboundproxy.1.enable\r\nline.8.outboundproxy.1.enable\r\nline.9.outboundproxy.1.enable\r\nline.10.outboundproxy.1.enable\r\nline.11.outboundproxy.1.enable\r\nline.12.outboundproxy.1.enable\r\nline.13.outboundproxy.1.enable\r\nline.1.outboundproxy.1.server\r\nline.2.outboundproxy.1.server\r\nline.3.outboundproxy.1.server\r\nline.4.outboundproxy.1.server\r\nline.5.outboundproxy.1.server\r\nline.6.outboundproxy.1.server\r\nline.7.outboundproxy.1.server\r\nline.8.outboundproxy.1.server\r\nline.9.outboundproxy.1.server\r\nline.10.outboundproxy.1.server\r\nline.11.outboundproxy.1.server\r\nline.12.outboundproxy.1.server\r\nline.13.outboundproxy.1.server\r\nline.1.outboundproxy.1.port\r\nline.2.outboundproxy.1.port\r\nline.3.outboundproxy.1.port\r\nline.4.outboundproxy.1.port\r\nline.5.outboundproxy.1.port\r\nline.6.outboundproxy.1.port\r\nline.7.outboundproxy.1.port\r\nline.8.outboundproxy.1.port\r\nline.9.outboundproxy.1.port\r\nline.10.outboundproxy.1.port\r\nline.11.outboundproxy.1.port\r\nline.12.outboundproxy.1.port\r\nline.13.outboundproxy.1.port\r\nline.1.outboundproxy.1.transport\r\nline.2.outboundproxy.1.transport\r\nline.3.outboundproxy.1.transport\r\nline.4.outboundproxy.1.transport\r\nline.5.outboundproxy.1.transport\r\nline.6.outboundproxy.1.transport\r\nline.7.outboundproxy.1.transport\r\nline.8.outboundproxy.1.transport\r\nline.9.outboundproxy.1.transport\r\nline.10.outboundproxy.1.transport\r\nline.11.outboundproxy.1.transport\r\nline.12.outboundproxy.1.transport\r\nline.13.outboundproxy.1.transport\r\nline.1.outboundproxy.2.enable\r\nline.2.outboundproxy.2.enable\r\nline.3.outboundproxy.2.enable\r\nline.4.outboundproxy.2.enable\r\nline.5.outboundproxy.2.enable\r\nline.6.outboundproxy.2.enable\r\nline.7.outboundproxy.2.enable\r\nline.8.outboundproxy.2.enable\r\nline.1.outboundproxy.2.server\r\nline.2.outboundproxy.2.server\r\nline.3.outboundproxy.2.server\r\nline.4.outboundproxy.2.server\r\nline.5.outboundproxy.2.server\r\nline.1.outboundproxy.2.port\r\nline.2.outboundproxy.2.port\r\nline.3.outboundproxy.2.port\r\nline.4.outboundproxy.2.port\r\nline.5.outboundproxy.2.port\r\nline.1.outboundproxy.2.transport"}]}]}},{"id":"ebf37310-a476-f185-caa8-1be17b8b1746","label":"Assumptions & Limitations","body":{"version":1,"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"Default friendly names that Phonism provided are supported for the following brands:"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"text","text":"Polycom"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"text","text":"Yealink"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"text","text":"Cisco"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"text","text":"Snom"}]}]}]},{"type":"paragraph","content":[]}]}}] |