Documentation of the caller id


The ABC system - the system by call Authentication (Authentication call).
ID Call - up call on the phone numbers provided Pathcount, to confirm.
After receipt of the incoming call, the incoming number is logged, and Pathcount sends a signal "Busy," which guarantees free identification for all participants.

The ABC system of FiveRooms, allows users to identify web resources phone numbers, using direct call.

The ABC system is the caller ID.

The possibility of applying ABC system Pathcount do not have limitations - the system can be used to control access to web services and web resources (personal offices, control panel, etc.), be used to confirm transactions (payment, signing of electronic documents).

Soon


Use the API


You can download API library.

The system of identification of ABC Pathcount provides the possibility to external developers software means to receive and to write data to the system Authenticationbycall.com. One of the ways of such interaction is use of the API.

What are the API

The API defines a set of functions to which the developers can perform requests and receive responses. The interaction occurs over HTTP. The advantage of this approach is the wide the distribution of the HTTP Protocol, so you can use the API from almost any language programming.

The API is designed mainly for requests from external servers to servers Authenticationbycall.com.

How to use API

All API calls is HTTP GET requests to the URL https://www.authenticationbycall.com/api/get and HTTP POST requests to the URL https://www.Authenticationbycall.com/api with a certain set of parameters. You choose in the documentation of the method, for example, authpost generates the query according to the documentation of the method, and carry out the request. In response to the request, you get the result, which is also described in the documentation of each function. The encoding of the result UTF-8.

For example, in PHP, to implement such a request you can use cURL, Perl LWP::Simple, Python — httplib, use cURL from the command line, and even just your browser.

The request data can be transmitted in the body of a POST request.
Request parameters

Each request must contain a set of mandatory parameters. Also for each function in its documentation specified additional options only needed for this function. Text parameter values must be passed in UTF-8. The same for all functions settings listed below.

Name Type Description
method string the name of the invoked method, for example, authpost; required parameter
customer_telephone int the ID of the administrator; required parameter
api_token string API token; mandatory parameter
customer_token string token administrator
The order of the parameters in the query does not matter.

All the parameters placed on the page https://authenticationbycall.com/applications/ when opening detailed information of each form.

For example:

Let your data obtained from creating the form to be
api_token = xxxxxxxxxx
form_token = rrrrrrrrrrrrrr // marker shape, received on the /applications/

And you need to authenticate the user at the phone number on the page, for this you you must use additional option:
telephone = 55555555555 // phone user passing identity

The POST query will look like this:

 $url = 'https://authenticationbycall.com/api/';
 $params = array(
  'method' => 'authpost',
  'api_token' => 'xxxxxxxxxx',
  'form_token' => 'rrrrrrrrrrrrrr',
  'telephone' => '55555555555',
 );

 $myCurl = curl_init();
 curl_setopt_array($myCurl, array(
  CURLOPT_URL => $url,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_POST => true,
  CURLOPT_POSTFIELDS => http_build_query($params)
 ));
 $response = curl_exec($myCurl);
 curl_close($myCurl);

GET query will look like this:

https://authenticationbycall.com/api/get?method=authpost&api_token=xxxxxxxxxx&form_token=rrrrrrrrrrrrrr&telephone=55555555555


Use file_get_contents for GET-query (PHP example):

$link = "https://authenticationbycall.com/api/get?method=authpost&api_token=xxxxxxxxxx&form_token=rrrrrrrrrrrrrr&telephone=55555555555";
$response = file_get_contents($link);

In response, you will receive a unique identifier for this specific identification (uniq_id) and the rooms phones, call on any of them will be successful confirmation of the user number (in our case 55555555555).
The data received from https://authenticationbycall.com/api/ will be in JSON format, so they need to decode and then to use.

 $response = json_decode($response, true);
 print_r($response);


Security API usage based on what api_token only you know and authenticationbycall.com. Therefore, never disclose it to third parties. If you have any doubts about security api, recommended to re-create the form on the page https://authenticationbycall.com/applications/.

authpost
authget
phonenumbersget



Method authpost

Description:
authpost - Adds a new record identification to activate call waiting.

Parameters POST-query:
method (STRING) - authpost
api_token (STRING) - the API token
form_token (STRING) - token of the form
telephone (INT) - the user's telephone number

Parameters GET-query:
method (STRING) - authpost
api_token (STRING) - the API token
form_token (STRING) - token of the form
telephone (INT) - the user's telephone number

Example POST request:

$url = 'https://authenticationbycall.com/api/';
$params = array(
'method' => 'authpost',
'api_token' => 'VhXkKVhXkK7yTRpAaALRpAaALdu'
'form_token' => '7a180f34c67a180f34c67a180f34c6'
'telephone' => '78888888888'
);
$myCurl = curl_init();
curl_setopt_array($myCurl, array(
CURLOPT_URL => $url,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => http_build_query($params)
));
$response = curl_exec($myCurl);
curl_close($myCurl);
$response = json_decode($response, true);
print_r($response);


Example GET-request:

https://authenticationbycall.com/api/get?method=authpost&api_token=xxxxxxxxxx&form_token=rrrrrrrrrrrrrr&telephone=55555555555

Result:

Array ( [EN] => 78007755267 [EU] => 448000869805 [uniq_id] => 59cccccc650 )

[EN] - phone number to dial from Russian Federation
[EU] - phone number to dial from the EU
[uniq_id] - a unique identification token generated



Description:
authget - Returns the status of specific identification.

the Parameters:
method (STRING) - authget
api_token (STRING) - the API token
form_token (STRING) - token of the form
uniq_id (STRING) - the token identification

Parameters GET-query:
method (STRING) - authget
api_token (STRING) - the API token
form_token (STRING) - token of the form
uniq_id (STRING) - the token identification

Example POST-request:

$url = 'https://authenticationbycall.com/api/';
$params = array(
'method' => 'authget', 'api_token' => 'VhXkKVhXkK7yTRpAaALRpAaALdu'
'form_token' => '7a180f34c67a180f34c67a180f34c6'
'uniq_id' => '59cccccc650', );
$myCurl = curl_init();
curl_setopt_array($myCurl, array(
CURLOPT_URL => $url,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => http_build_query($params)
));
$response = curl_exec($myCurl);
curl_close($myCurl);
$response = json_decode($response, true);
print_r($response);


Example GET-request:

https://authenticationbycall.com/api/get?method=authget&api_token=xxxxxxxxxx&form_token=rrrrrrrrrrrrrr&uniq_id=59cccccc650

Result:

Array ( [auth_status] => 0 [telephone] => 79281516173)

[telephone] is the user's phone number
[auth_status] - status of specific identification.

Parameters of [auth_status]:
[0] = authentication dropped
[1] = waiting for call
[2] = authentication successful

the Description:
phonenumbersget - Returns the list of phone numbers used to confirmation numbers (numbers, which is dial-up users).

the Parameters:
method (STRING) phonenumbersget
api_token (STRING) - the API token
form_token (STRING) - token of the form

Parameters GET-query:
method (STRING) - phonenumbersget
api_token (STRING) - the API token
form_token (STRING) - token of the form

Example POST-request:

$url = 'https://authenticationbycall.com/api/';
$params = array(
'method' => 'phonenumbersget', 'api_token' => 'VhXkKVhXkK7yTRpAaALRpAaALdu'
'form_token' => '7a180f34c67a180f34c67a180f34c6',
);
$myCurl = curl_init();
curl_setopt_array($myCurl, array(
CURLOPT_URL => $url,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => http_build_query($params)
));
$response = curl_exec($myCurl);
curl_close($myCurl);
$response = json_decode($response, true);
print_r($response);


Example GET-request:

https://authenticationbycall.com/api/get?method=phonenumbersget&api_token=xxxxxxxxxx&form_token=rrrrrrrrrrrrrr

Result:

Array ( [EN] => 78007755267 [EU] => 448000869805 )

[RU] - phone number to dial from Russian Federation
[EU] - phone number to dial from the EU



Error 001 Unknown error: Please resubmit the request.
Error 002 Unknown method called.
Error 003 Service Unavailable. Please try again later.
Error 004 Method is deprecated.
Error 005 Empty method.
Error 099 Telephone number specified is missing or invalid.
Error 100 One of the parameters specified is missing or invalid.
Error 102 Customer authorization failed: the form_token or api_token is incorrect.
Error 000 Nothing found.

















Powered by Authenticationbycall.com 2017