Voice OTP

This user authorization mechanism (action confirmation) is the simplest for the subscriber and the cheapest and most flexible for the client.
This tool allows you to make a call to the subscriber's number from an any number known to the client in advance.
The subscriber enters the last digits of the incoming number on the client's website (system). The client knows in advance which digits are correct to be able to authorize the subscriber.

URI: /api/json.php

All requests to API are sent in JSON format using the POST method.

Header parameters

Requests must contain header Content-Type: application/json, otherwise, the request will be considered invalid even if it has valid JSON.

Request parameters

authstringrequired Your API key, which can be obtained in your personal cabinet

datalist[object]required List of objects with request parameters typestringrequired Request type idnumberrequired Unique message identifier in the client system phonenumberrequired Phone number to be checked

Request example

{
    "auth": "bb56a4369eb19***cfec6d1776bd25",
    "data": [
        {
            "type": "call/otp",
            "id": 100500,
            "phone": 380971234567
        }
    ]
}

Response parameters

successinteger Result of request execution

errorstring Error text, returned if success=false

datalist[object] List of objects with the results of request execution successboolean Request execution result returned in the data packet dataobject Request execution result codestring OTP code (4 last digits of the phone number) pricenumber Verification fee

Response examples

Successful

HTTP Status Code: 200
Content Type: JSON application/json

{
    "success": true,
    "data": [
        {
            "success": true,
            "data": {
                "code": "0471",
                "price": 0.2
            }
        }
    ]
}

Access denied

HTTP Status Code: 200
Content Type: JSON application/json

{
    "success": false,
    "error": "Access denied"
}

Operator not supported

HTTP Status Code: 200
Content Type: JSON application/json

{
    "success": false,
    "error": "Operator not supported"
}