Gilraen Data API

API Endpoint

https://api.gilraen.biz

Используя данный API вы можете получить доступ к обезличенной информации о телефонных номерах — рейтингу доверия, количеству блокировок, тегах присвоенных номеру, количеству отзывов, региону и оператору номера.

Для работы с API необходимо получить ключ доступа. Более подробно про условия и тарифы вы можете узнать на https://gilraen.biz

Домен — https://api.gilraen.biz

Все запросы к API подписываются сигнатурой:

к параметрам запроса добавляется:
- timestamp = текущее время в формате Unix
- signature = рассчет описан далее

формируем строку method+host+url+params+secret где:
- method=GET — метод запроса
- host=api.gilraen.biz — хост
- url=/api/preview/v1/limits — урл запрашиваемого метода
- params=key=nO0hy3rrzaCP9VPz8cPnCe1eyc5wiAjM3dAp2U38MB02lQmclm&timestamp=1616541199 отсортированные по алфавиту параметры запроса (и query и body вместе) за исключением signature также параметры должны пройти нормализацию в соответствии с RFC 3986 (url_encode)
- secret=test — секретный пароль (участвует в генреации сигнатуры, но не передается)
кодируем строку sha256
- пример сторки GETapi.gilraen.biz/v1/limitskey=nO0hy3rrzaCP9VPz8cPnCe1eyc5wiAjM3dAp2U38MB02lQmclm&timestamp=1616541199test
- пример результата ddb8e8062e93d3fca4c3a624b770a29d8f4ce59c270803163c101a21b4bd5fd1

Запросы к API ограничены лимитом в соответствии с тарифом (кроме запроса на просмотр лимита)

Методы ¶

Лимиты ¶

GET https://api.gilraen.biz/v1/limits?timestamp=1616541199&key=nO0hy3rrzaCP9VPz8cPnCe1eyc5wiAjM3dAp2U38MB02l&signature=ddb8e8062e93d3fca4c3a624b770a29d8f4ce59c270803163c101a21b4bd5fd1

Responses200401419

Headers

Content-Type: application/json

Body

{
  "status_code": 0,
  "status": "success",
  "message": "",
  "data": {
    "limits": 354
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status_code": {
      "type": "number"
    },
    "status": {
      "type": "string"
    },
    "message": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "limits": {
          "type": "number"
        }
      }
    }
  }
}

Headers

Content-Type: application/json

Body

{
  "status_code": "401",
  "status": "Unauthorized",
  "message": "Unauthorized or limit used up",
  "data": ""
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status_code": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "message": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

Headers

Content-Type: application/json

Body

{
  "status_code": "419",
  "status": "signature error",
  "message": "signature failed verification",
  "data": ""
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status_code": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "message": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

Лимиты
GET`/v1/limits?timestamp={timestamp}&key={key}&signature={signature}`

Лимиты на обращения к API.

URI Parameters

HideShow

key: string (required) Example: nO0hy3rrzaCP9VPz8cPnCe1eyc5wiAjM3dAp2U38MB02l
ключ API
timestamp: number (required) Example: 1616541199
отметка времени
signature: string (required) Example: ddb8e8062e93d3fca4c3a624b770a29d8f4ce59c270803163c101a21b4bd5fd1
сигнатура запроса

Рейтинг доверия ¶

GET https://api.gilraen.biz/v1/index?timestamp=1616541199&key=nO0hy3rrzaCP9VPz8cPnCe1eyc5wiAjM3dAp2U38MB02l&number=79991234567&signature=ddb8e8062e93d3fca4c3a624b770a29d8f4ce59c270803163c101a21b4bd5fd1

Responses200401419

Headers

Content-Type: application/json

Body

{
  "status_code": 0,
  "status": "success",
  "message": "",
  "data": {
    "index": 6.45
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status_code": {
      "type": "number"
    },
    "status": {
      "type": "string"
    },
    "message": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "index": {
          "type": "number"
        }
      }
    }
  }
}

Headers

Content-Type: application/json

Body

{
  "status_code": "401",
  "status": "Unauthorized",
  "message": "Unauthorized or limit used up",
  "data": ""
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status_code": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "message": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

Headers

Content-Type: application/json

Body

{
  "status_code": "419",
  "status": "signature error",
  "message": "signature failed verification",
  "data": ""
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status_code": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "message": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

Рейтинг доверия
GET`/v1/index?timestamp={timestamp}&key={key}&number={number}&signature={signature}`

Рейтинг доверия к номеру телефона Диапазон значений 0.00 .. 10.00 Значение по умолчанию - 5.00

URI Parameters

HideShow

key: string (required) Example: nO0hy3rrzaCP9VPz8cPnCe1eyc5wiAjM3dAp2U38MB02l
ключ API
number: number (required) Example: 79991234567
номер телефона в формате e.164
timestamp: number (required) Example: 1616541199
отметка времени
signature: string (required) Example: ddb8e8062e93d3fca4c3a624b770a29d8f4ce59c270803163c101a21b4bd5fd1
сигнатура запроса

Блокировки ¶

GET https://api.gilraen.biz/v1/bans?timestamp=1616541199&key=nO0hy3rrzaCP9VPz8cPnCe1eyc5wiAjM3dAp2U38MB02l&number=79991234567&signature=ddb8e8062e93d3fca4c3a624b770a29d8f4ce59c270803163c101a21b4bd5fd1

Responses200401419

Headers

Content-Type: application/json

Body

{
  "status_code": 0,
  "status": "success",
  "message": "",
  "data": {
    "bans": 145
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status_code": {
      "type": "number"
    },
    "status": {
      "type": "string"
    },
    "message": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "bans": {
          "type": "number"
        }
      }
    }
  }
}

Headers

Content-Type: application/json

Body

{
  "status_code": "401",
  "status": "Unauthorized",
  "message": "Unauthorized or limit used up",
  "data": ""
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status_code": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "message": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

Headers

Content-Type: application/json

Body

{
  "status_code": "419",
  "status": "signature error",
  "message": "signature failed verification",
  "data": ""
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status_code": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "message": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

Блокировки
GET`/v1/bans?timestamp={timestamp}&key={key}&number={number}&signature={signature}`

Счетчик банов номера телефона

URI Parameters

HideShow

key: string (required) Example: nO0hy3rrzaCP9VPz8cPnCe1eyc5wiAjM3dAp2U38MB02l
ключ API
number: number (required) Example: 79991234567
номер телефона в формате e.164
timestamp: number (required) Example: 1616541199
отметка времени
signature: string (required) Example: ddb8e8062e93d3fca4c3a624b770a29d8f4ce59c270803163c101a21b4bd5fd1
сигнатура запроса

Топ тегов ¶

GET https://api.gilraen.biz/v1/tags_top?timestamp=1616541199&key=nO0hy3rrzaCP9VPz8cPnCe1eyc5wiAjM3dAp2U38MB02l&number=79991234567&signature=ddb8e8062e93d3fca4c3a624b770a29d8f4ce59c270803163c101a21b4bd5fd1

Responses200401419

Headers

Content-Type: application/json

Body

{
  "status_code": 0,
  "status": "success",
  "message": "",
  "data": {
    "tags": {
      "callerType": {
        "id": 11,
        "count": 11
      },
      "categories": [
        {
          "id": 1146,
          "count": 245
        },
        {
          "id": 1144,
          "count": 159
        }
      ],
      "subcategories": [
        {
          "id": 10036,
          "count": 154
        },
        {
          "id": 10037,
          "count": 4
        }
      ],
      "callReasons": [
        {
          "id": 100009,
          "count": 156
        },
        {
          "id": 100006,
          "count": 150
        }
      ],
      "emotags": [
        {
          "id": 200003,
          "count": 4041
        }
      ]
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status_code": {
      "type": "number"
    },
    "status": {
      "type": "string"
    },
    "message": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "tags": {
          "type": "object",
          "properties": {
            "callerType": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "count": {
                  "type": "number"
                }
              }
            },
            "categories": {
              "type": "array"
            },
            "subcategories": {
              "type": "array"
            },
            "callReasons": {
              "type": "array"
            },
            "emotags": {
              "type": "array"
            }
          }
        }
      }
    }
  }
}

Headers

Content-Type: application/json

Body

{
  "status_code": "401",
  "status": "Unauthorized",
  "message": "Unauthorized or limit used up",
  "data": ""
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status_code": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "message": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

Headers

Content-Type: application/json

Body

{
  "status_code": "419",
  "status": "signature error",
  "message": "signature failed verification",
  "data": ""
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status_code": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "message": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

Топ тегов
GET`/v1/tags_top?timestamp={timestamp}&key={key}&number={number}&signature={signature}`

Топ тегов по типам. До 5 штук в каждой категории

URI Parameters

HideShow

key: string (required) Example: nO0hy3rrzaCP9VPz8cPnCe1eyc5wiAjM3dAp2U38MB02l
ключ API
number: number (required) Example: 79991234567
номер телефона в формате e.164
timestamp: number (required) Example: 1616541199
отметка времени
signature: string (required) Example: ddb8e8062e93d3fca4c3a624b770a29d8f4ce59c270803163c101a21b4bd5fd1
сигнатура запроса

Флаг "Нежелательные звонки" ¶

GET https://api.gilraen.biz/v1/unwanted?timestamp=1616541199&key=nO0hy3rrzaCP9VPz8cPnCe1eyc5wiAjM3dAp2U38MB02l&number=79991234567&signature=ddb8e8062e93d3fca4c3a624b770a29d8f4ce59c270803163c101a21b4bd5fd1

Responses200401419

Headers

Content-Type: application/json

Body

{
  "status_code": 0,
  "status": "success",
  "message": "",
  "data": {
    "is_unwanted": false
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status_code": {
      "type": "number"
    },
    "status": {
      "type": "string"
    },
    "message": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "is_unwanted": {
          "type": "boolean"
        }
      }
    }
  }
}

Headers

Content-Type: application/json

Body

{
  "status_code": "401",
  "status": "Unauthorized",
  "message": "Unauthorized or limit used up",
  "data": ""
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status_code": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "message": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

Headers

Content-Type: application/json

Body

{
  "status_code": "419",
  "status": "signature error",
  "message": "signature failed verification",
  "data": ""
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status_code": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "message": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

Флаг "Нежелательные звонки"
GET`/v1/unwanted?timestamp={timestamp}&key={key}&number={number}&signature={signature}`

URI Parameters

HideShow

key: string (required) Example: nO0hy3rrzaCP9VPz8cPnCe1eyc5wiAjM3dAp2U38MB02l
ключ API
number: number (required) Example: 79991234567
номер телефона в формате e.164
timestamp: number (required) Example: 1616541199
отметка времени
signature: string (required) Example: ddb8e8062e93d3fca4c3a624b770a29d8f4ce59c270803163c101a21b4bd5fd1
сигнатура запроса

Оператор и регион ¶

GET https://api.gilraen.biz/v1/carrier_region?timestamp=1616541199&key=nO0hy3rrzaCP9VPz8cPnCe1eyc5wiAjM3dAp2U38MB02l&number=79991234567&signature=ddb8e8062e93d3fca4c3a624b770a29d8f4ce59c270803163c101a21b4bd5fd1

Responses200401419

Headers

Content-Type: application/json

Body

{
  "status_code": 0,
  "status": "success",
  "message": "",
  "data": {
    "carrier": "ПАО \"МегаФон\"",
    "region": "Россия, Краснодарский край"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status_code": {
      "type": "number"
    },
    "status": {
      "type": "string"
    },
    "message": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "carrier": {
          "type": "string"
        },
        "region": {
          "type": "string"
        }
      }
    }
  }
}

Headers

Content-Type: application/json

Body

{
  "status_code": "401",
  "status": "Unauthorized",
  "message": "Unauthorized or limit used up",
  "data": ""
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status_code": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "message": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

Headers

Content-Type: application/json

Body

{
  "status_code": "419",
  "status": "signature error",
  "message": "signature failed verification",
  "data": ""
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status_code": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "message": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

Оператор и регион
GET`/v1/carrier_region?timestamp={timestamp}&key={key}&number={number}&signature={signature}`

URI Parameters

HideShow

key: string (required) Example: nO0hy3rrzaCP9VPz8cPnCe1eyc5wiAjM3dAp2U38MB02l
ключ API
number: number (required) Example: 79991234567
номер телефона в формате e.164
timestamp: number (required) Example: 1616541199
отметка времени
signature: string (required) Example: ddb8e8062e93d3fca4c3a624b770a29d8f4ce59c270803163c101a21b4bd5fd1
сигнатура запроса

Количество отзывов ¶

GET https://api.gilraen.biz/v1/comments?timestamp=1616541199&key=nO0hy3rrzaCP9VPz8cPnCe1eyc5wiAjM3dAp2U38MB02l&number=79991234567&signature=ddb8e8062e93d3fca4c3a624b770a29d8f4ce59c270803163c101a21b4bd5fd1

Responses200401419

Headers

Content-Type: application/json

Body

{
  "status_code": 0,
  "status": "success",
  "message": "",
  "data": {
    "comments_count": 5
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status_code": {
      "type": "number"
    },
    "status": {
      "type": "string"
    },
    "message": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "comments_count": {
          "type": "number"
        }
      }
    }
  }
}

Headers

Content-Type: application/json

Body

{
  "status_code": "401",
  "status": "Unauthorized",
  "message": "Unauthorized or limit used up",
  "data": ""
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status_code": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "message": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

Headers

Content-Type: application/json

Body

{
  "status_code": "419",
  "status": "signature error",
  "message": "signature failed verification",
  "data": ""
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status_code": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "message": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

Количество отзывов
GET`/v1/comments?timestamp={timestamp}&key={key}&number={number}&signature={signature}`

URI Parameters

HideShow

key: string (required) Example: nO0hy3rrzaCP9VPz8cPnCe1eyc5wiAjM3dAp2U38MB02l
ключ API
number: number (required) Example: 79991234567
номер телефона в формате e.164
timestamp: number (required) Example: 1616541199
отметка времени
signature: string (required) Example: ddb8e8062e93d3fca4c3a624b770a29d8f4ce59c270803163c101a21b4bd5fd1
сигнатура запроса

Словарь тегов ¶

GET https://api.gilraen.biz/v1/tags_list?timestamp=1616541199&key=nO0hy3rrzaCP9VPz8cPnCe1eyc5wiAjM3dAp2U38MB02l&signature=ddb8e8062e93d3fca4c3a624b770a29d8f4ce59c270803163c101a21b4bd5fd1

Responses200401419

Headers

Content-Type: application/json

Body

{
  "status_code": 0,
  "status": "success",
  "message": "",
  "data": {
    "tagsList": [
      {
        "type": "CALLER_TYPE",
        "id": 10,
        "name": "Person"
      },
      {
        "type": "CATEGORY",
        "id": 1145,
        "name": "Transport"
      },
      {
        "type": "SUBCATEGORY",
        "id": 10041,
        "name": "Taxi"
      },
      {
        "type": "CALL_REASON",
        "id": 100009,
        "name": "SPAM"
      },
      {
        "type": "EMOTAG",
        "id": 200000,
        "name": "Like"
      }
    ]
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status_code": {
      "type": "number"
    },
    "status": {
      "type": "string"
    },
    "message": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "tagsList": {
          "type": "array"
        }
      }
    }
  }
}

Headers

Content-Type: application/json

Body

{
  "status_code": "401",
  "status": "Unauthorized",
  "message": "Unauthorized or limit used up",
  "data": ""
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status_code": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "message": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

Headers

Content-Type: application/json

Body

{
  "status_code": "419",
  "status": "signature error",
  "message": "signature failed verification",
  "data": ""
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status_code": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "message": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

Словарь тегов
GET`/v1/tags_list?timestamp={timestamp}&key={key}&signature={signature}`

Список возможных тегов.

Уникальный ключ — type + id (в рамках одного type не могут повторяться id)

Возможные типы:

CALLER_TYPE
CATEGORY
SUBCATEGORY
CALL_REASON
EMOTAG

URI Parameters

HideShow

key: string (required) Example: nO0hy3rrzaCP9VPz8cPnCe1eyc5wiAjM3dAp2U38MB02l
ключ API
timestamp: number (required) Example: 1616541199
отметка времени
signature: string (required) Example: ddb8e8062e93d3fca4c3a624b770a29d8f4ce59c270803163c101a21b4bd5fd1
сигнатура запроса

Комбинированный метод ¶

GET https://api.gilraen.biz/v1/number?timestamp=1616541199&key=nO0hy3rrzaCP9VPz8cPnCe1eyc5wiAjM3dAp2U38MB02l&number=79991234567&opt_fields=bans,index,unwanted&signature=ddb8e8062e93d3fca4c3a624b770a29d8f4ce59c270803163c101a21b4bd5fd1

Responses200401419

Headers

Content-Type: application/json

Body

{
  "status_code": 0,
  "status": "success",
  "message": "",
  "data": {
    "bans": 145,
    "index": 6.45,
    "is_unwanted": false
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status_code": {
      "type": "number"
    },
    "status": {
      "type": "string"
    },
    "message": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "bans": {
          "type": "number"
        },
        "index": {
          "type": "number"
        },
        "is_unwanted": {
          "type": "boolean"
        }
      }
    }
  }
}

Headers

Content-Type: application/json

Body

{
  "status_code": "401",
  "status": "Unauthorized",
  "message": "Unauthorized or limit used up",
  "data": ""
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status_code": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "message": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

Headers

Content-Type: application/json

Body

{
  "status_code": "419",
  "status": "signature error",
  "message": "signature failed verification",
  "data": ""
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status_code": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "message": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

Комбинированный метод
GET`/v1/number?timestamp={timestamp}&key={key}&number={number}&opt_fields={opt_fields}&signature={signature}`

Метод отдает набор данных о номере в одном запросе. Каждое поле, кроме limits, потребляет единицу лимита. Примеры:

opt_fields=bans,index,tags_top,unwanted,comments тратит 5 единиц лимита.
opt_fields=index тратит 1 единицу лимита.

При недостаточном лимите на запросы вернется ошибка.

URI Parameters

HideShow

key

string (required) Example: nO0hy3rrzaCP9VPz8cPnCe1eyc5wiAjM3dAp2U38MB02l

ключ API

number

number (required) Example: 79991234567

номер телефона в формате e.164

opt_fields

string (required) Example: bans,index,unwanted

список желаемых параметров через запятую

bans
index
tags_top
unwanted
comments
limits
carrier_region

timestamp

number (required) Example: 1616541199

отметка времени

signature

string (required) Example: ddb8e8062e93d3fca4c3a624b770a29d8f4ce59c270803163c101a21b4bd5fd1

сигнатура запроса

Generated by aglio on 07 Jun 2021

API Endpoint

Общая информация ¶

Расчет Сигнатуры ¶

Лимиты ¶

Методы ¶

Лимиты ¶

Headers

Body

Schema

Headers

Body

Schema

Headers

Body

Schema

ЛимитыGET/v1/limits?timestamp={timestamp}&key={key}&signature={signature}

Рейтинг доверия ¶

Headers

Body

Schema

Headers

Body

Schema

Headers

Body

Schema

Рейтинг доверияGET/v1/index?timestamp={timestamp}&key={key}&number={number}&signature={signature}

Блокировки ¶

Headers

Body

Schema

Headers

Body

Schema

Headers

Body

Schema

БлокировкиGET/v1/bans?timestamp={timestamp}&key={key}&number={number}&signature={signature}

Топ тегов ¶

Headers

Body

Schema

Headers

Body

Schema

Headers

Body

Schema

Топ теговGET/v1/tags_top?timestamp={timestamp}&key={key}&number={number}&signature={signature}

Флаг "Нежелательные звонки" ¶

Headers

Body

Schema

Headers

Body

Schema

Headers

Body

Schema

Флаг "Нежелательные звонки"GET/v1/unwanted?timestamp={timestamp}&key={key}&number={number}&signature={signature}

Оператор и регион ¶

Headers

Body

Schema

Headers

Body

Schema

Headers

Body

Schema

Оператор и регионGET/v1/carrier_region?timestamp={timestamp}&key={key}&number={number}&signature={signature}

Количество отзывов ¶

Headers

Body

Schema

Headers

Body

Schema

Headers

Body

Общая информация

Расчет Сигнатуры

Лимиты

Лимиты
GET`/v1/limits?timestamp={timestamp}&key={key}&signature={signature}`

Рейтинг доверия
GET`/v1/index?timestamp={timestamp}&key={key}&number={number}&signature={signature}`

Блокировки
GET`/v1/bans?timestamp={timestamp}&key={key}&number={number}&signature={signature}`

Топ тегов
GET`/v1/tags_top?timestamp={timestamp}&key={key}&number={number}&signature={signature}`

Флаг "Нежелательные звонки"
GET`/v1/unwanted?timestamp={timestamp}&key={key}&number={number}&signature={signature}`

Оператор и регион
GET`/v1/carrier_region?timestamp={timestamp}&key={key}&number={number}&signature={signature}`

Количество отзывов
GET`/v1/comments?timestamp={timestamp}&key={key}&number={number}&signature={signature}`

Словарь тегов
GET`/v1/tags_list?timestamp={timestamp}&key={key}&signature={signature}`

Комбинированный метод
GET`/v1/number?timestamp={timestamp}&key={key}&number={number}&opt_fields={opt_fields}&signature={signature}`