MOR API device callflow get

From Kolmisoft Wiki
Revision as of 05:39, 13 August 2013 by Tester2 (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search

Description

MOR API Device Call Flow get

Usage

  • Call: /api/device_callflow_get
  • Methods: POST, GET(if allowed, not recomended)



Parametres



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.



See also