למאגר המידע של מסקיו

Maskyoo API 16

Users Methods related

Set ddi to user

This function will assign a maskyoo number to user


/api/?service=set_ddi_to_user

Usage and SDK Samples


curl -H "Authorization: Bearer < TOKEN_FROM_SYSTEM >" -X get "https://[MASKYOO_URL]/api/?service=set_ddi_to_user&user_id=&maskyoo=&format="
												

using System.Net;
using System.Collections.Specialized;
namespace Examples.System.Net
{
    public class WebRequestPostExample
    {
        public static void Main ()
        {
			string url_query_string="https://[MASKYOO_URL]/api/?";
			using (var client = new WebClient())
			{
				var values = new NameValueCollection();
				values["service"] = "set_ddi_to_user";
				values["user_id"] = "12";
				values["maskyoo"] = "972737373737";
				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="https://[MASKYOO_URL]/api/";
	$data = array(
		"service" => "set_ddi_to_user",                 
		"user_id" => "12",        			
		"maskyoo" => "972737373737",        			
		"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
user_id*
maskyoo*
format

Responses

Status: 200 - Success response

Status: 8001 - error user id can't be empty

Status: 8002 - error maskyoo number can't be empty

Status: 8003 - no results for user id xxx

Status: 8004 - no results for maskyoo number xxxxxxxxxx

Status: 8005 - error setting user_id xxx to maskyoo xxxxxxxxxxx

Status: 8006 - error user_id xxx and maskyoo xxxxxxxxxx already set


Set user

This function purpuse is to create a new user for the system use


/api/?service=set_user

Usage and SDK Samples


curl -H "Authorization: Bearer < TOKEN_FROM_SYSTEM >" -X get "https://[MASKYOO_URL]/api/?service=set_user&email=&password=&user_phone=&user_phone_sms=&format="
												

using System.Net;
using System.Collections.Specialized;
namespace Examples.System.Net
{
    public class WebRequestPostExample
    {
        public static void Main ()
        {
			string url_query_string="https://[MASKYOO_URL]/api/?";
			using (var client = new WebClient())
			{
				var values = new NameValueCollection();
				values["service"] = "set_user";
				values["email"] = "[email protected]";
				values["password"] = "MyPaSsw0rd";
				values["user_phone"] = "972544224422";
				values["user_phone_sms"] = "972544224422";
				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="https://[MASKYOO_URL]/api/";
	$data = array(
		"service" => "set_user",  
		"email" => "[email protected]",
		"password" => "MyPaSsw0rd", 
		"user_phone" => "972544224422",      
		"user_phone_sms" => "972544224422",
		"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
email*
password*
user_phone
user_phone_sms
format

Responses

Status: 200 - Success response

Status: 7001 - error the email is empty or longer then 100 chars

Status: 7002 - error password is require and more then 8 chars

Status: 7003 - error creating user

Status: 7004 - error add profile to user

Status: 7005 - error creating user privileges


Update user

This function update User details


/api/?service=update_user

Usage and SDK Samples


curl -H "Authorization: Bearer < TOKEN_FROM_SYSTEM >" -X get "https://[MASKYOO_URL]/api/?service=update_user&user_id=&password=&user_phone=&user_phone_sms=&user_status=&format="
												

using System.Net;
using System.Collections.Specialized;
namespace Examples.System.Net
{
    public class WebRequestPostExample
    {
        public static void Main ()
        {
			string url_query_string="https://[MASKYOO_URL]/api/?";
			using (var client = new WebClient())
			{
				var values = new NameValueCollection();
				values["service"] = "update_user";
				values["user_id"] = "12";
				values["password"] = "MyPaSsw0rd";
				values["user_phone"] = "972544224422";
				values["user_phone_sms"] = "972544224422";
				values["user_status"] = "1";
				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="https://[MASKYOO_URL]/api/";
	$data = array(
		"service" => "update_user",  
		"user_id" => "12",
		"password" => "MyPaSsw0rd", 
		"user_phone" => "972544224422",      
		"user_phone_sms" => "972544224422",    
		"user_status" => "1",    
		"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
user_id*
password
user_phone
user_phone_sms
user_status
format

Responses

Status: 200 - Success response

Status: 7011 - error user id cant be empty

Status: 7012 - error update user


Delete user

This function will delete user data by id


/api/?service=delete_user

Usage and SDK Samples


curl -H "Authorization: Bearer < TOKEN_FROM_SYSTEM >" -X get "https://[MASKYOO_URL]/api/?service=delete_user&user_id=&format="
												

using System.Net;
using System.Collections.Specialized;
namespace Examples.System.Net
{
    public class WebRequestPostExample
    {
        public static void Main ()
        {
			string url_query_string="https://[MASKYOO_URL]/api/?";
			using (var client = new WebClient())
			{
				var values = new NameValueCollection();
				values["service"] = "delete_user";
				values["user_id"] = "12";
				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="https://[MASKYOO_URL]/api/";
	$data = array(
		"service" => "delete_user",  
		"user_id" => "12",  
		"user_status" => "1",
		"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
user_id*
format

Responses

Status: 200 - Success response

Status: 7021 - error user id cant be empty

Status: 7022 - error user_id xxx not exist

Status: 7023 - error delete user

Status: 7024 - error delete users_ddi

Status: 7025 - error delete users_profile

Status: 7026 - error delete users_privileges


Get ddi by user id

This function will retrive all maskyoo numbers that are assigned to user by user id


/api/?service=get_ddi_by_user_id

Usage and SDK Samples


curl -H "Authorization: Bearer < TOKEN_FROM_SYSTEM >" -X get "https://[MASKYOO_URL]/api/?service=get_ddi_by_user_id&user_id=&format="
												

using System.Net;
using System.Collections.Specialized;
namespace Examples.System.Net
{
    public class WebRequestPostExample
    {
        public static void Main ()
        {
			string url_query_string="https://[MASKYOO_URL]/api/?";
			using (var client = new WebClient())
			{
				var values = new NameValueCollection();
				values["service"] = "get_ddi_by_user_id";
				values["user_id"] = "12";
				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="https://[MASKYOO_URL]/api/";
	$data = array(
		"service" => "get_ddi_by_user_id",  
		"user_id" => "12", 
		"user_status" => "1",
		"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
user_id*
format

Responses

Status: 200 - Success response

Status: 8011 - error user id can't be empty

Status: 8012 - no results for user_id xxx


Delete ddi from user id

This function will delete assignment of maskyoo number to user by user id


/api/?service=delete_ddi_from_user_id

Usage and SDK Samples


curl -H "Authorization: Bearer < TOKEN_FROM_SYSTEM >" -X get "https://[MASKYOO_URL]/api/?service=delete_ddi_from_user_id&user_id=&maskyoo=&format="
												

using System.Net;
using System.Collections.Specialized;
namespace Examples.System.Net
{
    public class WebRequestPostExample
    {
        public static void Main ()
        {
			string url_query_string="https://[MASKYOO_URL]/api/?";
			using (var client = new WebClient())
			{
				var values = new NameValueCollection();
				values["service"] = "delete_ddi_from_user_id";
				values["user_id"] = "12";
				values["maskyoo"] = "972737373737";
				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="https://[MASKYOO_URL]/api/";
	$data = array(
		"service" => "delete_ddi_from_user_id",  
		"user_id" => "12",
		"maskyoo" => "972737373737",   
		"user_status" => "1",
		"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
user_id*
maskyoo*
format

Responses

Status: 200 - Success response

Status: 8021 - error user id can't be empty

Status: 8022 - error maskyoo number can't be empty

Status: 8023 - no results for user id xxx

Status: 8024 - no results for maskyoo number xxxxxxxxxx

Status: 8025 - error user_id xxx and maskyoo xxxxxxxxxxx not set

Status: 8026 - error maskyoo xxxxxxxxx not removed from user_id xxx


Get user by id

This function will retrive user data in the system by id


/api/?service=get_user_by_id

Usage and SDK Samples


curl -H "Authorization: Bearer < TOKEN_FROM_SYSTEM >" -X get "https://[MASKYOO_URL]/api/?service=get_user_by_id&user_id=&format="
												

using System.Net;
using System.Collections.Specialized;
namespace Examples.System.Net
{
    public class WebRequestPostExample
    {
        public static void Main ()
        {
			string url_query_string="https://[MASKYOO_URL]/api/?";
			using (var client = new WebClient())
			{
				var values = new NameValueCollection();
				values["service"] = "get_user_by_id";
				values["user_id"] = "12";
				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="https://[MASKYOO_URL]/api/";
	$data = array(
		"service" => "get_user_by_id",  
		"user_id" => "12",  
		"user_status" => "1",
		"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
user_id*
format

Responses

Status: 200 - Success response

Status: 7031 - error user id cant be empty

Status: 7032 - no results for user id xxx


Get user access log

This function allows querying regarding login attempts to the maskyoo system made in a specific range of dates.


/api/?service=get_users_access_log

Usage and SDK Samples


curl -H "Authorization: Bearer < TOKEN_FROM_SYSTEM >" -X get "https://[MASKYOO_URL]/api/?service=get_users_access_log&user_id=&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="https://[MASKYOO_URL]/api/?";
			using (var client = new WebClient())
			{
				var values = new NameValueCollection();
				values["service"] = "get_users_access_log";
				values["user_id"] = "12";
				values["start_time"] = "2017-01-15 16:00:00";
				values["end_time"] = "2017-01-15 16:30: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="https://[MASKYOO_URL]/api/";
	$data = array(
		"service" => "get_users_access_log",  
		"user_id" => "12", 
		"start_time" => "2017-01-15 16:00:00",
		"end_time" => "2017-01-15 16:30:00", 
		"user_status" => "1",
		"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
user_id
start_time
end_time
format

Responses

Status: 200 - Success response

Status: 6001 - there is no result


Get users

This function will retrive all users data in the system


/api/?service=get_users

Usage and SDK Samples


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

using System.Net;
using System.Collections.Specialized;
namespace Examples.System.Net
{
    public class WebRequestPostExample
    {
        public static void Main ()
        {
			string url_query_string="https://[MASKYOO_URL]/api/?";
			using (var client = new WebClient())
			{
				var values = new NameValueCollection();
				values["service"] = "get_users";
				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="https://[MASKYOO_URL]/api/";
	$data = array(
		"service" => "get_users",  
		"user_status" => "1",
		"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
format

Responses

Status: 200 - Success response

Status: 7041 - no results


Generated 2017-02-01 12:00:00