Difference between revisions of "MOR API autodialer get campaign ivr poll results"

From Kolmisoft Wiki
Jump to navigationJump to search
(Created page with '=Description= Retrieves autodialer campaign ivr poll results.<br><br> =Usage= * From '''MOR X16''': '''/api/autodialer_get_campaign_ivr_poll_results''' <br><br> ===Parameters==…')
 
 
Line 18: Line 18:


* [[MOR API hash construction | hash]] - SHA1 hash constructed using parameters above and API_Secret_Key ([[MOR API hash construction | More described in Constructing hash]]). '''Required''' (if setting '''Disable hash checking''' is not checked).  
* [[MOR API hash construction | hash]] - SHA1 hash constructed using parameters above and API_Secret_Key ([[MOR API hash construction | More described in Constructing hash]]). '''Required''' (if setting '''Disable hash checking''' is not checked).  
* u - username  for authentication. '''Required'''. <!---NUO x4 password nereikalaujamas--->
* order_by - Possible values [time, src, dst, prefix, nice_billsec, hgc, server, p_name, p_rate, p_price, reseller, r_rate, r_price, user, u_rate, u_price, number, d_provider, d_inc, d_owner]. (Default: time).  <!---Nuo MOR 9--->
* <!---Nuo MOR X6---> s_reseller - Reseller type User ID in MOR database.  (Default: all).
<br><br><!---Nuo MOR 8 buvo, o nuo MOR 9 nebėra direction---> <!---Iki nuo 11 buvo s_did_pattern, s_reseller_did, vėliau nebeliko--->


===Request===
===Request===

Latest revision as of 07:56, 3 June 2020

Description

Retrieves autodialer campaign ivr poll results.

Usage

  • From MOR X16: /api/autodialer_get_campaign_ivr_poll_results



Parameters

Parameters which are included into hash:

  • u - username for authentication. Required.
  • id - Campaign ID in MOR database. Required. Included into hash.

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:

Request

If you want to get campaign ivr poll results for username: some_user, for campaign ID 2 and your API Secret Key = 456789

You send: 

HTML POST:  http://<SERVER_IP>/billing/api/autodialer_get_campaign_ivr_poll_results?u=some_user&id=2&hash=38282ca5e65e63746498ef5b39a2fe71c6448999



Returns

Success: Everything is ok. You get the list of calls if there is any: 


<?xml version="1.0" encoding="UTF-8"?>
<page>
 <status>
   <ivr_poll_results_string>1111
2222,2020-01-01 01:01:01,2090-12-31 23:59:59</ivr_poll_results_string>
 </status>
</page>

Errors:

  • <error>You are not authorized to use this functionality</error>* - You are not authorized to use this functionality
  • <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
  • <error>Access Denied</error> - Such username does not exist in the database or it was not specified.
  • <error>Campaign was not found</error> - Such Campaign ID does not exist in the database.
  • <error>Campaign does not have any Numbers</error> - Selected Campaign does not have any Numbers.

See also

Retrieved from "https://wiki.kolmisoft.com/index.php?title=MOR_API_autodialer_get_campaign_ivr_poll_results&oldid=25648"