Developer APIs

Owned by Marc Tribbe
Last updated: 2024 Sept 19
3 min read

Create an API key and configure friendly names.

https://www.youtube.com/watch?v=yNDdTC1uvpk

The 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.

This API also offers low-code/no-code integrations for integrating the functions of our platform into your own customer experience.

Note: Default friendly names are supported for the following brands:

  • Polycom

  • Yealink

  • Cisco

  • Snom

CREATE API KEY

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.

  1. Navigate to the hierarchy location where you wish to create an API key.

  2. Select the Integrations tab.

  3. Click Add New Integration.

  4. In the Type drop-down menu, select Generate your own API Key.

  5. Enter a Name for the key.

  6. Click Add.

image-20240730-211409.png

FRIENDLY NAMES CONFIGURATION

Configuration parameters can be mapped to aliases in the system to be used in API calls which are called “friendly names.”

  • You can get all the friendly names defined in the system with the following API call:

Get Available Friendly Names

  • You can add a new friendly name to the system with the following API call:

Add Friendly Name

  • You can update the existing friendly name in the system with the following API call:

Update Friendly Name

  • You can delete the existing friendly name from the system with the following API call:

Delete Friendly Name

DEFAULT FRIENDLY NAMES

Phonism has the following friendly names defined by default:

  1. line.1.enable

  2. line.2.enable

  3. line.3.enable

  4. line.4.enable

  5. line.5.enable

  6. line.6.enable

  7. line.7.enable

  8. line.8.enable

  9. line.9.enable

  10. line.10.enable

  11. line.11.enable

  12. line.12.enable

  13. line.13.enable

  14. line.1.username

  15. line.2.username

  16. line.3.username

  17. line.4.username

  18. line.5.username

  19. 1line.6.username

  20. line.7.username

  21. line.8.username

  22. line.9.username

  23. line.10.username

  24. line.11.username

  25. line.12.username

  26. line.13.username

  27. line.1.authname

  28. line.2.authname

  29. line.3.authname

  30. line.4.authname

  31. line.5.authname

  32. line.6.authname

  33. line.7.authname

  34. line.8.authname

  35. line.9.authname

  36. line.10.authname

  37. line.11.authname

  38. line.12.authname

  39. line.13.authname

  40. line.1.password

  41. line.2.password

  42. line.3.password

  43. line.4.password

  44. line.5.password

  45. line.6.password

  46. line.7.password

  47. line.8.password

  48. line.9.password

  49. line.10.password

  50. line.11.password

  51. line.12.password

  52. line.13.password

  53. line.1.sipuri

  54. line.2.sipuri

  55. line.3.sipuri

  56. line.4.sipuri

  57. line.5.sipuri

  58. line.6.sipuri

  59. line.7.sipuri

  60. line.8.sipuri

  61. line.9.sipuri

  62. line.10.sipuri

  63. line.11.sipuri

  64. line.12.sipuri

  65. line.13.sipuri

  66. line.1.label

  67. line.2.label

  68. line.3.label

  69. line.4.label

  70. line.5.label

  71. line.6.label

  72. line.7.label

  73. line.8.label

  74. line.9.label

  75. line.10.label

  76. line.11.label

  77. line.12.label

  78. line.13.label

  79. line.1.displayname

  80. line.2.displayname

  81. line.3.displayname

  82. line.4.displayname

  83. line.5.displayname

  84. line.6.displayname

  85. line.7.displayname

  86. line.8.displayname

  87. line.9.displayname

  88. line.10.displayname

  89. line.11.displayname

  90. line.12.displayname

  91. line.13.displayname

  92. line.1.dialplan

  93. line.2.dialplan

  94. line.3.dialplan

  95. line.4.dialplan

  96. line.5.dialplan

  97. line.6.dialplan

  98. line.7.dialplan

  99. line.8.dialplan

  100. line.9.dialplan

  101. line.10.dialplan

  102. line.11.dialplan

  103. line.12.dialplan

  104. line.13.dialplan

  105. line.1.digitmap

  106. line.2.digitmap

  107. line.3.digitmap

  108. line.4.digitmap

  109. line.5.digitmap

  110. line.6.digitmap

  111. line.7.digitmap

  112. line.8.digitmap

  113. line.9.digitmap

  114. line.10.digitmap

  115. line.11.digitmap

  116. line.12.digitmap

  117. line.13.digitmap

  118. line.1.server.1.address

  119. line.2.server.1.address

  120. line.3.server.1.address

  121. line.4.server.1.address

  122. line.5.server.1.address

  123. line.6.server.1.address

  124. line.7.server.1.address

  125. line.8.server.1.address

  126. line.9.server.1.address

  127. line.10.server.1.address

  128. line.11.server.1.address

  129. line.12.server.1.address

  130. line.13.server.1.address

  131. line.1.server.1.port

  132. line.2.server.1.port

  133. line.3.server.1.port

  134. line.4.server.1.port

  135. line.5.server.1.port

  136. line.6.server.1.port

  137. line.7.server.1.port

  138. line.8.server.1.port

  139. line.9.server.1.port

  140. line.10.server.1.port

  141. line.11.server.1.port

  142. line.12.server.1.port

  143. line.13.server.1.port

  144. line.1.server.1.transport

  145. line.2.server.1.transport

  146. line.3.server.1.transport

  147. line.4.server.1.transport

  148. line.5.server.1.transport

  149. line.6.server.1.transport

  150. line.7.server.1.transport

  151. line.8.server.1.transport

  152. line.9.server.1.transport

  153. line.10.server.1.transport

  154. line.11.server.1.transport

  155. line.12.server.1.transport

  156. line.13.server.1.transport

  157. line.1.server.1.registration.address

  158. line.1.server.1.registration.port

  159. line.1.server.2.address

  160. line.2.server.2.address

  161. line.3.server.2.address

  162. line.4.server.2.address

  163. line.5.server.2.address

  164. line.6.server.2.address

  165. line.7.server.2.address

  166. line.8.server.2.address

  167. line.9.server.2.address

  168. line.10.server.2.address

  169. line.11.server.2.address

  170. line.12.server.2.address

  171. line.13.server.2.address

  172. line.1.server.2.port

  173. line.2.server.2.port

  174. line.3.server.2.port

  175. line.4.server.2.port

  176. line.5.server.2.port

  177. line.6.server.2.port

  178. line.7.server.2.port

  179. line.8.server.2.port

  180. line.9.server.2.port

  181. line.10.server.2.port

  182. line.11.server.2.port

  183. line.12.server.2.port

  184. line.13.server.2.port

  185. line.1.server.2.transport

  186. line.2.server.2.transport

  187. line.3.server.2.transport

  188. line.4.server.2.transport

  189. line.5.server.2.transport

  190. line.6.server.2.transport

  191. line.7.server.2.transport

  192. line.8.server.2.transport

  193. line.9.server.2.transport

  194. line.10.server.2.transport

  195. line.11.server.2.transport

  196. line.12.server.2.transport

  197. line.13.server.2.transport

  198. line.1.server.2.registration.address

  199. line.1.server.2.registration.port

  200. line.1.outboundproxy.1.enable

  201. line.2.outboundproxy.1.enable

  202. line.3.outboundproxy.1.enable

  203. line.4.outboundproxy.1.enable

  204. line.5.outboundproxy.1.enable

  205. line.6.outboundproxy.1.enable

  206. line.7.outboundproxy.1.enable

  207. line.8.outboundproxy.1.enable

  208. line.9.outboundproxy.1.enable

  209. line.10.outboundproxy.1.enable

  210. line.11.outboundproxy.1.enable

  211. line.12.outboundproxy.1.enable

  212. line.13.outboundproxy.1.enable

  213. line.1.outboundproxy.1.server

  214. line.2.outboundproxy.1.server

  215. line.3.outboundproxy.1.server

  216. line.4.outboundproxy.1.server

  217. line.5.outboundproxy.1.server

  218. line.6.outboundproxy.1.server

  219. line.7.outboundproxy.1.server

  220. line.8.outboundproxy.1.server

  221. line.9.outboundproxy.1.server

  222. line.10.outboundproxy.1.server

  223. line.11.outboundproxy.1.server

  224. line.12.outboundproxy.1.server

  225. line.13.outboundproxy.1.server

  226. line.1.outboundproxy.1.port

  227. line.2.outboundproxy.1.port

  228. line.3.outboundproxy.1.port

  229. line.4.outboundproxy.1.port

  230. line.5.outboundproxy.1.port

  231. line.6.outboundproxy.1.port

  232. line.7.outboundproxy.1.port

  233. line.8.outboundproxy.1.port

  234. line.9.outboundproxy.1.port

  235. line.10.outboundproxy.1.port

  236. line.11.outboundproxy.1.port

  237. line.12.outboundproxy.1.port

  238. line.13.outboundproxy.1.port

  239. line.1.outboundproxy.1.transport

  240. line.2.outboundproxy.1.transport

  241. line.3.outboundproxy.1.transport

  242. line.4.outboundproxy.1.transport

  243. line.5.outboundproxy.1.transport

  244. line.6.outboundproxy.1.transport

  245. line.7.outboundproxy.1.transport

  246. line.8.outboundproxy.1.transport

  247. line.9.outboundproxy.1.transport

  248. line.10.outboundproxy.1.transport

  249. line.11.outboundproxy.1.transport

  250. line.12.outboundproxy.1.transport

  251. line.13.outboundproxy.1.transport

  252. line.1.outboundproxy.2.enable

  253. line.2.outboundproxy.2.enable

  254. line.3.outboundproxy.2.enable

  255. line.4.outboundproxy.2.enable

  256. line.5.outboundproxy.2.enable

  257. line.6.outboundproxy.2.enable

  258. line.7.outboundproxy.2.enable

  259. line.8.outboundproxy.2.enable

  260. line.1.outboundproxy.2.server

  261. line.2.outboundproxy.2.server

  262. line.3.outboundproxy.2.server

  263. line.4.outboundproxy.2.server

  264. line.5.outboundproxy.2.server

  265. line.1.outboundproxy.2.port

  266. line.2.outboundproxy.2.port

  267. line.3.outboundproxy.2.port

  268. line.4.outboundproxy.2.port

  269. line.5.outboundproxy.2.port

  270. line.1.outboundproxy.2.transport