Maskyoo API 16

Querys Methods related

Cdr query

This function allows receiving all data about phone calls using SQL querying, and receiving the answers in JSON or XML. • This function requires knowledge with SQL language of My SQL server


/api/?service=cdr_query

Usage and SDK Samples


	curl -H "Authorization: Bearer < TOKEN_FROM_SYSTEM >" -X get "http://[MASKYOO_URL]/api/?service=cdr_query&sql=&format="
	

using System.Net;
using System.Collections.Specialized;
namespace Examples.System.Net
{
    public class WebRequestPostExample
    {
        public static void Main ()
        {
			string url_query_string="http://[MASKYOO_URL]/api/?";
			using (var client = new WebClient())
			{
				var values = new NameValueCollection();
				values["service"] = "cdr_query";
				values["sql"] = "SELECT id, start_call, end_call, call_duration, cdr_ani, cdr_ddi, onetouch, user_phone, user_name, cdr_uniqueid, call_status FROM webserviceview limit 2 ";
				values["format"] = "json";

				client.Headers.Add("Authorization","Bearer < TOKEN_FROM_SYSTEM >");
                var response = client.UploadValues(url_query_string, values);

				var responseString = Encoding.Default.GetString(response);
				Console.WriteLine (responseString);
			}
        }
    }
}
	

<?php
	$base_url="http://[MASKYOO_URL]/api/";
	$data = array(
		"service" => "cdr_query",                        
		"sql" => "SELECT id, start_call, end_call, call_duration, cdr_ani, cdr_ddi, onetouch, user_phone, user_name, cdr_uniqueid, call_status FROM webserviceview limit 2 ",
		"format" => "json"      
	);
	echo post_data($base_url, $data);

	function post_data($url, $data){
		$fields = '';
		foreach($data as $key => $value) { 
			$fields .= $key . '=' . $value . '&'; 
		}
		rtrim($fields, '&');
		$post = curl_init();
		curl_setopt($post, CURLOPT_URL, $url);
		curl_setopt($post, CURLOPT_POST, count($data));
		curl_setopt($post, CURLOPT_POSTFIELDS, $fields);
		curl_setopt($post, CURLOPT_RETURNTRANSFER, 1);
        curl_setopt($post, CURLOPT_HTTPHEADER, array("Authorization: Bearer < TOKEN_FROM_SYSTEM >"));
		$result = curl_exec($post);
		curl_close($post);
		return $result; 
	}
?>
	

Parameters

Query parameters
Name Description
sql*
format

Responses

Status: 200 - Success response

Status: 1011 - there is no sql query

Status: 1012 - the sql query contain illigal sql (injection)

Status: 1013 - there is no result from the query or the query is incorrect


Cdr subunique query

This function purpose is to create a query within the data base and get back a full details on the unique calls made within the chosen timeframe, in addition to calls made from anonymous sources.


/api/?service=cdr_subunique_query

Usage and SDK Samples


	curl -H "Authorization: Bearer < TOKEN_FROM_SYSTEM >" -X get "http://[MASKYOO_URL]/api/?service=cdr_subunique_query&start_time=&end_time=&format="
	

using System.Net;
using System.Collections.Specialized;
namespace Examples.System.Net
{
    public class WebRequestPostExample
    {
        public static void Main ()
        {
			string url_query_string="http://[MASKYOO_URL]/api/?";
			using (var client = new WebClient())
			{
				var values = new NameValueCollection();
				values["service"] = "cdr_subunique_query";
				values["start_time"] = "2017-01-10 10:00:00";
				values["end_time"] = "2017-01-10 10:10:00";
				values["format"] = "json";

				client.Headers.Add("Authorization","Bearer < TOKEN_FROM_SYSTEM >");
                var response = client.UploadValues(url_query_string, values);

				var responseString = Encoding.Default.GetString(response);
				Console.WriteLine (responseString);
			}
        }
    }
}
	

<?php
	$base_url="http://[MASKYOO_URL]/api/";
	$data = array(
		"service" => "cdr_subunique_query",                 
		"start_time" => '2017-01-10 10:00:00',  							
		"end_time" => '2017-01-10 10:10:00',
		"format" => "json"      
	);
	echo post_data($base_url, $data);

	function post_data($url, $data){
		$fields = '';
		foreach($data as $key => $value) { 
			$fields .= $key . '=' . $value . '&'; 
		}
		rtrim($fields, '&');
		$post = curl_init();
		curl_setopt($post, CURLOPT_URL, $url);
		curl_setopt($post, CURLOPT_POST, count($data));
		curl_setopt($post, CURLOPT_POSTFIELDS, $fields);
		curl_setopt($post, CURLOPT_RETURNTRANSFER, 1);
        curl_setopt($post, CURLOPT_HTTPHEADER, array("Authorization: Bearer < TOKEN_FROM_SYSTEM >"));
		$result = curl_exec($post);
		curl_close($post);
		return $result; 
	}
?>
	

Parameters

Query parameters
Name Description
start_time*
end_time*
format

Responses

Status: 1001 - error cdr_subunique_query function need start_time(Y-m-d H:i:s) for get data

Status: 1002 - error cdr_subunique_query function need end_time(Y-m-d H:i:s) for get data

Status: 1003 - no results

Status: 200 - Success response


Get record by call uuid

This function purpose is to allow call recording sound file download (single call).


/api/?service=get_record_by_call_uuid

Usage and SDK Samples


	curl -H "Authorization: Bearer < TOKEN_FROM_SYSTEM >" -X get "http://[MASKYOO_URL]/api/?service=get_record_by_call_uuid&call_uuid=&type=&format="
	

using System.Net;
using System.Collections.Specialized;
namespace Examples.System.Net
{
    public class WebRequestPostExample
    {
        public static void Main ()
        {
			string url_query_string="http://[MASKYOO_URL]/api/?";
			using (var client = new WebClient())
			{
				var values = new NameValueCollection();
				values["service"] = "get_record_by_call_uuid";
				values["call_uuid"] = "123654.654";
				values["type"] = "mp3";
				values["format"] = "json";

				client.Headers.Add("Authorization","Bearer < TOKEN_FROM_SYSTEM >");
                var response = client.UploadValues(url_query_string, values);

				var responseString = Encoding.Default.GetString(response);
				Console.WriteLine (responseString);
			}
        }
    }
}
	

<?php
	$base_url="http://[MASKYOO_URL]/api/";
	$data = array(
		"service" => "get_record_by_call_uuid",
		"call_uuid" => "123654.654",
		"type" => "mp3",
		"format" => "json"      
	);
	echo post_data($base_url, $data);

	function post_data($url, $data){
		$fields = '';
		foreach($data as $key => $value) { 
			$fields .= $key . '=' . $value . '&'; 
		}
		rtrim($fields, '&');
		$post = curl_init();
		curl_setopt($post, CURLOPT_URL, $url);
		curl_setopt($post, CURLOPT_POST, count($data));
		curl_setopt($post, CURLOPT_POSTFIELDS, $fields);
		curl_setopt($post, CURLOPT_RETURNTRANSFER, 1);
        curl_setopt($post, CURLOPT_HTTPHEADER, array("Authorization: Bearer < TOKEN_FROM_SYSTEM >"));
		$result = curl_exec($post);
		curl_close($post);
		return $result; 
	}
?>
	

Parameters

Query parameters
Name Description
call_uuid*
type
format

Responses

Status: 200 - Success response

Status: 3001 - error call_uuid is require

Status: 3002 - error the call_uuid: XXXX not valid


Get cdr metadata

This function retrive call details and metadata information if exist for a single call.


/api/?service=get_cdr_metadata_by_call_uuid&call_uuid=

Usage and SDK Samples


	curl -H "Authorization: Bearer < TOKEN_FROM_SYSTEM >" -X get "http://[MASKYOO_URL]/api/?service=get_cdr_metadata_by_call_uuid&call_uuid=&type=&format="
	

using System.Net;
using System.Collections.Specialized;
namespace Examples.System.Net
{
    public class WebRequestPostExample
    {
        public static void Main ()
        {
			string url_query_string="http://[MASKYOO_URL]/api/?";
			using (var client = new WebClient())
			{
				var values = new NameValueCollection();
				values["service"] = "get_cdr_metadata_by_call_uuid";
				values["call_uuid"] = "123654.654";
				values["format"] = "json";

				client.Headers.Add("Authorization","Bearer < TOKEN_FROM_SYSTEM >");
                var response = client.UploadValues(url_query_string, values);

				var responseString = Encoding.Default.GetString(response);
				Console.WriteLine (responseString);
			}
        }
    }
}
	

<?php
	$base_url="http://[MASKYOO_URL]/api/";
	$data = array(
		"service" => "get_cdr_metadata_by_call_uuid",
		"call_uuid" => "123654.654",
		"format" => "json"      
	);
	echo post_data($base_url, $data);

	function post_data($url, $data){
		$fields = '';
		foreach($data as $key => $value) { 
			$fields .= $key . '=' . $value . '&'; 
		}
		rtrim($fields, '&');
		$post = curl_init();
		curl_setopt($post, CURLOPT_URL, $url);
		curl_setopt($post, CURLOPT_POST, count($data));
		curl_setopt($post, CURLOPT_POSTFIELDS, $fields);
		curl_setopt($post, CURLOPT_RETURNTRANSFER, 1);
        curl_setopt($post, CURLOPT_HTTPHEADER, array("Authorization: Bearer < TOKEN_FROM_SYSTEM >"));
		$result = curl_exec($post);
		curl_close($post);
		return $result; 
	}
?>
	

Parameters

Query parameters
Name Description
call_uuid*
format

Responses

Status: 200 - Success response

Status: 1014 - error call_uuid is require

Status: 1015 - error no result for call_uuid: XXXX



Get google ads offline conversion

This function retrive google offline conversion value and last update date.


/api/?service=get_google_ads_offline_conversion&call_uuid=

Usage and SDK Samples


     curl -H "Authorization: Bearer < TOKEN_FROM_SYSTEM >" -X get "http://[MASKYOO_URL]/api/?service=get_google_ads_offline_conversion&call_uuid=&type=&format="
     

using System.Net;
using System.Collections.Specialized;
namespace Examples.System.Net
{
    public class WebRequestPostExample
    {
        public static void Main ()
        {
               string url_query_string="http://[MASKYOO_URL]/api/?";
               using (var client = new WebClient())
               {
                    var values = new NameValueCollection();
                    values["service"] = "get_google_ads_offline_conversion";
                    values["call_uuid"] = "123654.654";
                    values["format"] = "json";

                    client.Headers.Add("Authorization","Bearer < TOKEN_FROM_SYSTEM >");
                var response = client.UploadValues(url_query_string, values);

                    var responseString = Encoding.Default.GetString(response);
                    Console.WriteLine (responseString);
               }
        }
    }
}
     

<?php
     $base_url="http://[MASKYOO_URL]/api/";
     $data = array(
          "service" => "get_google_ads_offline_conversion",
          "call_uuid" => "123654.654",
          "format" => "json"      
     );
     echo post_data($base_url, $data);

     function post_data($url, $data){
          $fields = '';
          foreach($data as $key => $value) { 
               $fields .= $key . '=' . $value . '&'; 
          }
          rtrim($fields, '&');
          $post = curl_init();
          curl_setopt($post, CURLOPT_URL, $url);
          curl_setopt($post, CURLOPT_POST, count($data));
          curl_setopt($post, CURLOPT_POSTFIELDS, $fields);
          curl_setopt($post, CURLOPT_RETURNTRANSFER, 1);
        curl_setopt($post, CURLOPT_HTTPHEADER, array("Authorization: Bearer < TOKEN_FROM_SYSTEM >"));
          $result = curl_exec($post);
          curl_close($post);
          return $result; 
     }
?>
     

Parameters

Query parameters
Name Description
call_uuid*
format

Responses

Status: 200 - Success response

Status: 1014 - error call_uuid is require

Status: 1015 - error no result for call_uuid: XXXX



Get google ads offline conversion

This function set google offline conversion value.


/api/?service=set_google_ads_offline_conversion&call_uuid=

Usage and SDK Samples


     curl -H "Authorization: Bearer < TOKEN_FROM_SYSTEM >" -X get "http://[MASKYOO_URL]/api/?service=set_google_ads_offline_conversion&call_uuid=&conversion_value=5&format="
     

using System.Net;
using System.Collections.Specialized;
namespace Examples.System.Net
{
    public class WebRequestPostExample
    {
        public static void Main ()
        {
               string url_query_string="http://[MASKYOO_URL]/api/?";
               using (var client = new WebClient())
               {
                    var values = new NameValueCollection();
                    values["service"] = "set_google_ads_offline_conversion";
                    values["call_uuid"] = "123654.654";
                    values["conversion_value"] = "5";
                    values["format"] = "json";

                    client.Headers.Add("Authorization","Bearer < TOKEN_FROM_SYSTEM >");
                var response = client.UploadValues(url_query_string, values);

                    var responseString = Encoding.Default.GetString(response);
                    Console.WriteLine (responseString);
               }
        }
    }
}
     

<?php
     $base_url="http://[MASKYOO_URL]/api/";
     $data = array(
          "service" => "set_google_ads_offline_conversion",
          "call_uuid" => "123654.654",
          "conversion_value" => "5",
          "format" => "json"      
     );
     echo post_data($base_url, $data);

     function post_data($url, $data){
          $fields = '';
          foreach($data as $key => $value) { 
               $fields .= $key . '=' . $value . '&'; 
          }
          rtrim($fields, '&');
          $post = curl_init();
          curl_setopt($post, CURLOPT_URL, $url);
          curl_setopt($post, CURLOPT_POST, count($data));
          curl_setopt($post, CURLOPT_POSTFIELDS, $fields);
          curl_setopt($post, CURLOPT_RETURNTRANSFER, 1);
        curl_setopt($post, CURLOPT_HTTPHEADER, array("Authorization: Bearer < TOKEN_FROM_SYSTEM >"));
          $result = curl_exec($post);
          curl_close($post);
          return $result; 
     }
?>
     

Parameters

Query parameters
Name Description
call_uuid*
conversion_value*
format

Responses

Status: 200 - Success response

Status: 1014 - error call_uuid is require

Status: 1015 - error no result for call_uuid: XXXX


Generated 2017-02-01 12:00:00