Difference between revisions of "MOR API callback init"
From Kolmisoft Wiki
Jump to navigationJump to search
| Line 12: | Line 12: | ||
===Parametres=== | ===Parametres=== | ||
Parameters which are '''included''' into hash: | |||
* '''device''' – device_id, which device should be used to initiate callback and which Caller ID will be set on the call (Device ID = Device ACC, or accountcode). You can find ACC in /billing/devices/devices_all). USER should be the owner of the device in MOR. | * '''device''' – device_id, which device should be used to initiate callback and which Caller ID will be set on the call (Device ID = Device ACC, or accountcode). You can find ACC in /billing/devices/devices_all). USER should be the owner of the device in MOR. | ||
* '''src''' – source, which number to dial first. | * '''src''' – source, which number to dial first. | ||
* '''dst''' – destination, which will be dialed when SOURCE answers. | * '''dst''' – destination, which will be dialed when SOURCE answers. | ||
'''Note that parameters are shown in the same order as they have to be when generating the hash. Last parameter in a row is API_Secret_Key''' | |||
<br><br> | |||
Parameters which are '''not included''' into hash: | |||
* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''user_id''', '''balance''' and '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''. | |||
* '''u''' – users username, not from the device! (user should be the owner of the device) | |||
<!---from x5---> | <!---from x5---> | ||
* '''cli_lega''' - callerID on legA. Optional. Takes higher priority then GUI settings. | * '''cli_lega''' - callerID on legA. Optional. Takes higher priority then GUI settings. | ||
* '''cli_legb''' - callerID on legB. Optional. Takes higher priority then GUI settings. | * '''cli_legb''' - callerID on legB. Optional. Takes higher priority then GUI settings. | ||
You can omit <DESTINATION>. If you do so, SOURCE will be asked to enter it. | You can omit <DESTINATION>. If you do so, SOURCE will be asked to enter it. | ||
<br><br> | <br><br> | ||
Revision as of 12:39, 28 May 2014
Description
Callback Addon is needed in order to use MOR API callback.
This API method is often used to implement Click2Call functionality from webpage. Also it can be used in CRM systems like SugarCRM, Salesforce and others.
Usage
- From MOR X4 call: /api/callback_init
- For Backwards-compatibility old name 'callback' is also usable. Call: /api/callback
- Methods: POST, GET(if allowed, not recomended)
Parametres
Parameters which are included into hash:
- device – device_id, which device should be used to initiate callback and which Caller ID will be set on the call (Device ID = Device ACC, or accountcode). You can find ACC in /billing/devices/devices_all). USER should be the owner of the device in MOR.
- src – source, which number to dial first.
- dst – destination, which will be dialed when SOURCE answers.
Note that parameters are shown in the same order as they have to be when generating the hash. Last parameter in a row is API_Secret_Key
Parameters which are not included into hash:
- hash - SHA1 hash constructed using user_id, balance and API_Secret_Key ( More described in Constructing hash). Required.
- u – users username, not from the device! (user should be the owner of the device)
- cli_lega - callerID on legA. Optional. Takes higher priority then GUI settings.
- cli_legb - callerID on legB. Optional. Takes higher priority then GUI settings.
You can omit <DESTINATION>. If you do so, SOURCE will be asked to enter it.
Request
HTML POST: http://<YOUR_SERVER_IP>/billing/api/callback?u=username&device=device_id&src=source&dst=destination
Returns
Success– Means callback is initiated.
<?xml version="1.0" encoding="UTF-8"?> <status>Ok</status>
Errors
Not authenticated – User is not present with provided username.
<?xml version="1.0" encoding="UTF-8"?> <status>Not authenticated</status>
Bad device – Device does not exist or Device should belong to user if user does not have 'admin' rights.
<?xml version="1.0" encoding="UTF-8"?> <status>Bad device</status>
No source – No source in request.
<?xml version="1.0" encoding="UTF-8"?> <status>No source</status>
Call is not received
- Check your CDR for a FAILED call and reason why it failed.
- Check Asterisk CLI for error.
- Use Call Tracing to locate the error and fix it.
