MOR API device callflow get

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

<user>Test User #1</user>
  <device>SIP/101</device>
  <callflow>
    <state>Before call</state>
    <priority>1</priority>
    <action></action>
    
    <data2/>
    <data3>1</data3>
    <data4/>
    <data5/>
  </callflow>
  <callflow>
    <state>Call</state>
    <priority>1</priority>
    <action>Dial</action>
    SIP/101|60
    <data2/>
    <data3>1</data3>
    <data4/>
    <data5/>
  </callflow>
  <callflow>
    <state>Answered</state>
    <priority>1</priority>
    <action>Hangup</action>
    
    <data2/>
    <data3>1</data3>
    <data4/>
    <data5/>
  </callflow>
  <callflow>
    <state>No answer</state>
    <priority>1</priority>
    <action></action>
    
    <data2/>
    <data3>1</data3>
    <data4/>
    <data5/>
  </callflow>
  <callflow>
    <state>Busy</state>
    <priority>1</priority>
    <action></action>
    
    <data2/>
    <data3>1</data3>
    <data4/>
    <data5/>
  </callflow>
  <callflow>
    <state>Failed</state>
    <priority>1</priority>
    <action></action>
    
    <data2/>
    <data3>1</data3>
    <data4/>
    <data5/>
  </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

• MOR API