Difference between revisions of "MOR API device callflow get"
From Kolmisoft Wiki
Jump to navigationJump to search
(Created page with '=Description= <!-- This functionality is available from MOR X3 --> MOR API Device Call Flow get <br><br> =Usage= * Call: '''/api/device_callflow_get''' * Methods: POST, GET(…') |
|||
| Line 1: | Line 1: | ||
=Description= | =Description= | ||
<!-- This functionality is available from MOR | <!-- This functionality is available from MOR X4 --> | ||
[[MOR API]] Device Call Flow get | [[MOR API]] Device Call Flow get | ||
<br><br> | <br><br> | ||
Revision as of 05:39, 13 August 2013
Description
MOR API Device Call Flow get
Usage
- Call: /api/device_callflow_get
- Methods: POST, GET(if allowed, not recomended)
Parametres
- u - username for authentication. Required.
- device_id - for device finding. Required.
- hash - SHA1 hash constructed using params and API_Secret_Key ( More described in Constructing hash). Required.
Request
We have API Secret Key = 456789, device_id = 100
We send:
HTML POST: http://<SERVER_IP>/billing/api/device_callflow_get?u=admin&device_id=100&hash=71516eea4850f7e0300ac86adf9fb64bca845aa7
* Note that username and password are not included in hash
Returns
Success
<page>
<user>Test User #1</user>
<device>FAX/102</device>
<callflow>
<state>Before call</state>
<priority>1</priority>
<action/>
</callflow
<callflow>
<state>Call</state>
<priority>1</priority>
<action>Dial</action>
FAX/102|60
</callflow>
<callflow>
<state>Answered</state>
<priority>1</priority>
<action>Hangup</action>
</callflow>
<callflow>
<state>No answer</state>
<priority>1</priority>
<action/>
</callflow>
<callflow>
<state>Busy</state>
<priority>1</priority>
<action/>
</callflow>
<callflow>
<state>Failed</state>
<priority>1</priority>
<action/>
</callflow>
</page>
Errors
- <error>Device was not found</error> – Device was not found.
- <error>You are not authorised to use this functionality</error> – you need permissions in order to view this function.
- <error>User was not found</error> – User was not found.
- <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.