RESTful API узла верификации
На данной инструкции описаны методы RESTful API узлов верификации ТелеСтор, которые подключены к ИС Антифрод и обслуживают операторов связи.
Для каждого метода поддерживается передача параметров в строке запроса, для POST-запросов параметры могут быть переданы так же в теле запроса в формате application/x-www-form-urlencoded или multipart/form-data. Параметры передаются в кодировке ASCII.
Верификация или регистрация вызова
Данный метод используется для регистрации вызовов в ИС Антифрод. Для входящих вызовов также будет выполнена их верификация.
| Метод | Путь |
|---|---|
| GET/POST | https://afXX.tlstr.ru/uXXXX/call |
| Параметр | Обязательное | Описание | Возможные значения и примеры |
|---|---|---|---|
| a | Да | Номер вызывающего абонента, в формате E.164* | Пример: 79251234567 |
| b | Да | Номер вызываемого абонента, в формате E.164* | Пример: 79251234567 |
| c | Нет | Номер, используемый для переадресации, в формате E.164* | Пример: 79251234567 |
| d | Нет | Дополнительный номер абонента, в формате E.164* | Пример: 79251234567 |
| call_id | Нет | Идентификатор соединения (вызова). | Текстовая строка, длиной до 100 символов. Приводится в случае наличия такого идентификатора. Заполняется оператором связи при наличии соответствующего поля (например call_id в SIP и т.п.) в протоколе сигнализации. |
| tag | Нет | Тег для определения источника и назначения вызова | Текстовая строка, длиной до 64 символов, которая используется в совокупности с IP-адресом, с которого был отправлен запрос, как идентификатор пира. Должен соответствовать согласованному значению из таблицы "Транки и пиры" |
| v | Нет | Признак отладки | При любом не пустом значении в ответы 200 и 404 будут добавлены информационные заголовки (см. ниже) |
*Возможна передача номеров абонентов в других форматах. Для этого обратитесь в нашу службу поддержки.
| Код ответа | Описание |
|---|---|
| 200 | Вызов прошел верификацию и зарегистрирован в ИС Антифрод |
| 403 | Доступ с данного IP-адреса запрещен |
| 404 | Вызов не найден на узле верификации оператора вызывающего абонента |
| 502 | Узел верификации не запущен |
В ответах с кодами 200 и 404 передаются следующие информационные заголовки, если в запросе был передан не пустой параметр v:
| Заголовок | Описание | Возможные значения и примеры |
|---|---|---|
| X-Frontida-Called-Number-Hash | Хеш номера вызываемого абонента | |
| X-Frontida-Operator-ID | Идентификатор оператора связи данного узла верификации | В соответствии с таблицей OPR. Пример: 11463 |
| X-Frontida-Uvr-ID | Идентификатор данного узла верификации | В соответствии с таблице UVR. Пример: 242 |
| X-Frontida-Exchange | Идентификатор модуля взаимодействия с АТС | |
| X-Frontida-Direction | Тип вызова | incoming - входящий, outgoing - исходящий, transit - транзитный вызов |
| X-Frontida-Peer-From | Идентификатор пира | |
| X-Frontida-ID-Src | Идентификатор оператора связи, из сети которого поступил вызов, определяется по идентификатору пира | Пример: 11463 |
| X-Frontida-ID-Dst | Идентификатор оператора связи, на сеть которого был отправлен вызов, определяется по идентификатору пира | Пример: 11463 |
| X-Frontida-Is-Trusted | Признак доверенного источника вызова | true - источник вызова является доверенным, верификация вызова не выполнялась |
| X-Frontida-Verification-Session-ID | Идентификатор сессии верификации вызова | |
| X-Frontida-Verification-Result | Результат верификации вызова | |
| X-Frontida-Verification-Duration-MS | Время, затраченное на выполнение верификации вызова, в милисекундах | |
| X-Frontida-Verification-UvrT-ID | Идентификатор узла верификации, который выполнял верификацию вызова | В соответствии с таблице UVR. Пример: 242 |
| X-Frontida-Result | Действие оператора связи для данного звонка | |
| X-Frontida-Notifications | Список уведомлений | Содержит дополнительные уведомления узла верификации, связанные с ошибками в обработке звонка |
Пример запроса:
curl https://afXX.tlstr.ru/uXXXX/call?a=78123332332&b=74958770000&call_id=c_00001&tag=op1&v=true
Регистрация дополнительных сведений о вызове
Данный метод используется для регистрации дополнительных сведений о вызове, которые стали известны после его совершения.
| Метод | Путь |
|---|---|
| GET/POST | https://afXX.tlstr.ru/uXXXX/call/update |
| Параметр | Обязательное | Описание | Возможные значения и примеры |
|---|---|---|---|
| ts | Да | Время совершения вызова | Должно быть не ранее чем за 6 часов до момента отправки запроса. Формат времени соответствует RFC 3339: ГГГГ-ММ-ДДTЧЧ:ММ:СС+ЧЧ:ММ. Пример: 2024-05-07T14:14:49+03:00 (Московское время 07.05.2024 14:14:49) |
| a | Да | Номер вызывающего абонента, в формате E.164* | Пример: 79251234567 |
| b | Да | Номер вызываемого абонента, в формате E.164* | Пример: 79251234567 |
| c | Нет | Номер, используемый для переадресации, в формате E.164* | Пример: 79251234567 |
| d | Нет | Дополнительный номер абонента, в формате E.164* | Пример: 79251234567 |
| call_id | Нет | Идентификатор соединения (вызова). | Текстовая строка, длиной до 100 символов. Приводится в случае наличия такого идентификатора. Заполняется оператором связи при наличии соответствующего поля (например call_id в SIP и т.п.) в протоколе сигнализации. |
| tag | Нет | Тег для определения источника и назначения вызова | Текстовая строка, длиной до 64 символов, которая используется в совокупности с IP-адресом, с которого был отправлен запрос, как идентификатор пира. Должен соответствовать согласованному значению из таблицы "Транки и пиры" |
| dur | Нет | Длительность вызова в секундах | |
| q850 | Нет | Код отбоя в соответствии с Q.850 | Пример: 16 |
| v | Нет | Признак отладки | При любом не пустом значении в ответы 200 и 404 будут добавлены информационные заголовки (см. ниже) |
*Возможна передача номеров абонентов в других форматах. Для этого обратитесь в нашу службу поддержки.
| Код ответа | Описание |
|---|---|
| 200 | Сведения зарегистрированы в ИС Антифрод |
| 400 | Ошибка в одном из параметров запроса |
| 403 | Доступ с данного IP-адреса запрещен |
| 502 | Узел верификации не запущен |
В ответах с кодом 200 передаются следующие информационные заголовки, если в запросе был передан не пустой параметр v:
| Заголовок | Описание | Возможные значения и примеры |
|---|---|---|
| X-Frontida-Called-Number-Hash | Хеш номера вызываемого абонента | |
| X-Frontida-Exchange | Идентификатор модуля взаимодействия с АТС | |
| X-Frontida-Peer-From | Идентификатор пира | |
| X-Frontida-ID-Src | Идентификатор оператора связи, из сети которого поступил вызов, определяется по идентификатору пира | Пример: 11463 |
| X-Frontida-ID-Dst | Идентификатор оператора связи, на сеть которого был отправлен вызов, определяется по идентификатору пира | Пример: 11463 |
| X-Frontida-Notifications | Список уведомлений | Содержит дополнительные уведомления узла верификации, связанные с ошибками в обработке звонка |
В ответах с кодом 400 в информационном заголовке X-Frontida-Notifications передается дополнительная информация об ошибке.
Пример запроса:
curl https://afXX.tlstr.ru/uXXXX/call/update?ts=2024-05-07T14:14:49+03:00&a=78123332332&b=74958770000&call_id=c_00001&tag=op1&dur=100&q850=16&&v=true
Получение информации из базы телефонной нумерации
Данный метод используется для получения информации о телефонном номере, операторе связи или узле верификации из база телефонной нумерации (таблицы NUM и DELTA).
| Метод | Путь |
|---|---|
| GET | https://afXX.tlstr.ru/uXXXX/registry |
| Параметр | Обязательное | Описание | Возможные значения и примеры |
|---|---|---|---|
| num | Нет | Телефонный номер, в формате E.164 | Пример: 79251234567 |
| opr | Нет | Идентификатор или ИНН оператора связи. Проверяется, если параметр num пустой или отсутствует | Идентификатор в соответствии с таблицей OPR. Примеры: 11463, 7811212947 |
| uvr | Нет | Идентификатор узла верификации. Проверяется, если параметры num и opr пустые или отсутствуют | В соответствии с таблице UVR. Пример: 242 |
| Код ответа | Описание |
|---|---|
| 200 | Информация найдена |
| 400 | Ошибка в одном из параметров запроса |
| 403 | Доступ с данного IP-адреса запрещен |
| 404 | Информация не найдена |
| 502 | Узел верификации не запущен |
Ответ с кодом 200 для получения информации о телефонном номере (в запросе был передан параметр num) содержит тело в формате JSON:
| Параметр | Тип | Описание |
|---|---|---|
| db_version | строка | версия базы телефонной нумерации |
| result | строка | Результат выполнения запроса |
| data.number | строка | Телефонный номер, переданный в запросе |
| data.id_src | целое число | Идентификатор оператора связи, в соответствии с таблицей OPR |
| data.id_uvr_p | целое число | Идентификатор основного узла верификации для данного номера, в соответствии с таблицей UVR |
| data.id_uvr_s | целое число | Идентификатор резервного узла верификации для данного номера, в соответствии с таблицей UVR |
| data.opr_info.opr_name | строка | Наименование оператора связи, в соответствии с таблицей OPR |
| data.opr_info.opr_nick | строка | Укороченное наименование оператора связи, в соответствии с таблицей OPR |
| data.opr_info.inn | строка | ИНН оператора связи, в соответствии с таблицей OPR |
| data.opr_info.bdpn_code | строка | Список пар: код оператора связи MNC и код организации OrgCode согласно БДПН, в соответствии с таблицей OPR |
| data.opr_info.name_brand | строка | Фирменное наименование оператора связи, в соответствии с таблицей OPR |
Пример запроса и ответа:
$ curl https://afXX.tlstr.ru/uXXXX/registry?num=78123332332 | jq
{
"db_version": "2024_07_01_13_00_00",
"result": "found",
"data": {
"number": "78123332332",
"id_src": 11463,
"id_uvr_p": 242,
"id_uvr_s": 0,
"opr_info": {
"opr_name": "ООО \"ТЕЛЕСТОР\"",
"opr_nick": "ООО \"ТЕЛЕСТОР\"",
"inn": "7811212947",
"bdpn_code": "",
"name_brand": ""
}
}
}
Ответ с кодом 200 для получения информации об операторе связи (в запросе был передан параметр opr) содержит тело в формате JSON:
| Параметр | Тип | Описание |
|---|---|---|
| db_version | строка | версия базы телефонной нумерации |
| result | строка | Результат выполнения запроса |
| data.opr | строка | Идентификатор или ИНН оператора связи, переданный в запросе |
| data.opr_info.id_src | целое число | Идентификатор оператора связи, в соответствии с таблицей OPR |
| data.opr_info.opr_name | строка | Наименование оператора связи, в соответствии с таблицей OPR |
| data.opr_info.opr_nick | строка | Укороченное наименование оператора связи, в соответствии с таблицей OPR |
| data.opr_info.inn | строка | ИНН оператора связи, в соответствии с таблицей OPR |
| data.opr_info.bdpn_code | строка | Список пар: код оператора связи MNC и код организации OrgCode согласно БДПН, в соответствии с таблицей OPR |
| data.opr_info.name_brand | строка | Фирменное наименование оператора связи, в соответствии с таблицей OPR |
| data.uvrs | массив | Список узлов верификации данного оператора связи |
| data.uvrs[].uvr | целое число | Идентификатор узла верификации, в соответствии с таблицей UVR |
| data.uvrs[].numbers.primary.count | целое число | Количество телефонных номеров, для которых данный узел верификации является основным |
| data.uvrs[].numbers.primary.ranges | массив | Список диапазонов телефонных номеров, для которых данный узел верификации является основным |
| data.uvrs[].numbers.primary.ranges[].begin | строка | Начало диапазона |
| data.uvrs[].numbers.primary.ranges[].end | строка | Конец диапазона |
| data.uvrs[].numbers.secondary.count | целое число | Количество телефонных номеров, для которых данный узел верификации является резервным |
| data.uvrs[].numbers.secondary.ranges | массив | Список диапазонов телефонных номеров, для которых данный узел верификации является резервным |
| data.uvrs[].numbers.secondary.ranges[].begin | строка | Начало диапазона |
| data.uvrs[].numbers.secondary.ranges[].end | строка | Конец диапазона |
Пример запроса и ответа:
$ curl https://afXX.tlstr.ru/uXXXX/registry?opr=11463 | jq
{
"db_version": "2024_07_01_13_00_00",
"result": "found",
"data": {
"opr": 11463,
"opr_info": {
"id_src": 11463,
"opr_name": "ООО \"ТЕЛЕСТОР\"",
"opr_nick": "ООО \"ТЕЛЕСТОР\"",
"inn": "7811212947",
"bdpn_code": "",
"name_brand": ""
},
"uvrs": [
{
"uvr": 242,
"numbers": {
"primary": {
"count": 117317,
"ranges": [
{
"begin": "74950010000",
"end": "74950014999"
},
[...]
{
"begin": "78127798800",
"end": "78127798999"
}
]
},
"secondary": {
"count": 0,
"ranges": []
}
}
},
{
"uvr": 2155,
"numbers": {
"primary": {
"count": 1,
"ranges": [
{
"begin": "78122210819",
"end": "78122210819"
}
]
},
"secondary": {
"count": 0,
"ranges": []
}
}
}
]
}
}
Ответ с кодом 200 для получения информации об узле верификации (в запросе был передан параметр uvr) содержит тело в формате JSON:
| Параметр | Тип | Описание |
|---|---|---|
| db_version | строка | версия базы телефонной нумерации |
| result | строка | Результат выполнения запроса |
| data.uvr | строка | Идентификатор узла верификации, переданный в запросе |
| data.uvr_info.gt_uvr | строка | Глобальный заголовок (GT) в формате E.164, в соответствии с таблицей UVR |
| data.uvr_info.ip_uvr_p | строка | Основной IP v4 адрес узла верификации, в соответствии с таблицей UVR |
| data.uvr_info.ip_uvr_s | строка | Резервный IP v4 адрес узла верификации, в соответствии с таблицей UVR |
| data.uvr_info.dns_uvr | строка | Доменное имя (DNS) узла верификации, в соответствии с таблицей UVR |
| data.uvr_info.id_hub_p | целое число | Идентификатор основного узла взаимодействия, в соответствии с таблицей UVR |
| data.uvr_info.hub_p_info.ip_hub_p | строка | IP v4 адрес основного хоста узла взаимодействий, в соответствии с таблицей HUB |
| data.uvr_info.hub_p_info.ip_hub_s | строка | IP v4 адрес резервного хоста узла взаимодействий, в соответствии с таблицей HUB |
| data.uvr_info.hub_p_info.dns_hub_p | строка | Доменное имя (DNS) основного хоста узла взаимодействий, в соответствии с таблицей HUB |
| data.uvr_info.hub_p_info.dns_hub_s | строка | Доменное имя (DNS) резервного хоста узла взаимодействий, в соответствии с таблицей HUB |
| data.uvr_info.id_hub_s | целое число | Идентификатор резервного узла взаимодействия, в соответствии с таблицей UVR |
| data.uvr_info.hub_s_info.ip_hub_p | строка | IP v4 адрес основного хоста узла взаимодействий, в соответствии с таблицей HUB |
| data.uvr_info.hub_s_info.ip_hub_s | строка | IP v4 адрес резервного хоста узла взаимодействий, в соответствии с таблицей HUB |
| data.uvr_info.hub_s_info.dns_hub_p | строка | Доменное имя (DNS) основного хоста узла взаимодействий, в соответствии с таблицей HUB |
| data.uvr_info.hub_s_info.dns_hub_s | строка | Доменное имя (DNS) резервного хоста узла взаимодействий, в соответствии с таблицей HUB |
| data.uvr_info.gt_uvr1 | строка | Глобальный заголовок (GT) в формате E.164, в соответствии с таблицей UVR |
| data.uvr_info.gt_uvr2 | строка | Глобальный заголовок (GT) в формате E.164, в соответствии с таблицей UVR |
| data.uvr_info.id_src | целое число | Идентификатор оператора связи владельца узла верификации, в соответствии с таблицей UVR |
| data.uvr_info.opr_info.opr_name | строка | Наименование оператора связи, в соответствии с таблицей OPR |
| data.uvr_info.opr_info.opr_nick | строка | Укороченное наименование оператора связи, в соответствии с таблицей OPR |
| data.uvr_info.opr_info.inn | строка | ИНН оператора связи, в соответствии с таблицей OPR |
| data.uvr_info.opr_info.bdpn_code | строка | Список пар: код оператора связи MNC и код организации OrgCode согласно БДПН, в соответствии с таблицей OPR |
| data.uvr_info.opr_info.name_brand | строка | Фирменное наименование оператора связи, в соответствии с таблицей OPR |
| data.numbers.primary.count | целое число | Количество телефонных номеров, для которых данный узел верификации является основным |
| data.numbers.primary.ranges | массив | Список диапазонов телефонных номеров, для которых данный узел верификации является основным |
| data.numbers.primary.ranges[].begin | строка | Начало диапазона |
| data.numbers.primary.ranges[].end | строка | Конец диапазона |
| data.numbers.secondary.count | целое число | Количество телефонных номеров, для которых данный узел верификации является резервным |
| data.numbers.secondary.ranges | массив | Список диапазонов телефонных номеров, для которых данный узел верификации является резервным |
| data.numbers.secondary.ranges[].begin | строка | Начало диапазона |
| data.numbers.secondary.ranges[].end | строка | Конец диапазона |
Пример запроса и ответа:
$ curl https://afXX.tlstr.ru/uXXXX/registry?uvr=2155 | jq
{
"db_version": "2024_07_01_13_00_00",
"result": "found",
"data": {
"uvr": "2155",
"uvr_info": {
"gt_uvr": "",
"ip_uvr_p": "11.1.1.68",
"ip_uvr_s": "11.1.129.63",
"dns_uvr": "",
"id_hub_p": 79582023000,
"hub_p_info": {
"ip_hub_p": "185.220.195.2",
"ip_hub_s": "185.220.195.3",
"dns_hub_p": "af-uvz-cfo1-msk-srv1.af.grfc.ru",
"dns_hub_s": "af-uvz-cfo1-msk-srv2.af.grfc.ru"
},
"id_hub_s": 79582023003,
"hub_s_info": {
"ip_hub_p": "185.220.195.10",
"ip_hub_s": "185.220.195.11",
"dns_hub_p": "af-uvz-cfo2-msk-srv1.af.grfc.ru",
"dns_hub_s": "af-uvz-cfo2-msk-srv2.af.grfc.ru"
},
"gt_uvr1": "",
"gt_uvr2": "",
"id_src": 11463,
"opr_info": {
"opr_name": "ООО \"ТЕЛЕСТОР\"",
"opr_nick": "ООО \"ТЕЛЕСТОР\"",
"inn": "7811212947",
"bdpn_code": "",
"name_brand": ""
}
},
"numbers": {
"primary": {
"count": 1,
"ranges": [
{
"begin": "78122210819",
"end": "78122210819"
}
]
},
"secondary": {
"count": 0,
"ranges": []
}
}
}
}
Ответ с кодами 400 и 404 содержит тело в формате JSON:
| Параметр | Тип | Описание |
|---|---|---|
| db_version | строка | версия базы телефонной нумерации |
| result | строка | Результат выполнения запроса |
| message | строка | Дополнительные сведения |
Поиск в истории звонков
Данный метод используется для получения информации об обработанных звонках. Аналогично данному методу обрабатываются запросы исторических данных от ГРЧЦ.
| Метод | Путь |
|---|---|
| GET | https://afXX.tlstr.ru/uXXXX/call/history |
| Параметр | Обязательное | Описание | Возможные значения и примеры |
|---|---|---|---|
| a | Да | Телефонный номер вызывающего абонента, в формате E.164 | Пример: 79251234567 |
| b | Да | Телефонный номер вызываемого абонента, в формате E.164 | Пример: 79251234567 |
| ts | Да | Время совершения вызова | Должно быть ранее чем за 2 минуты до момента отправки запроса. Формат времени соответствует RFC 3339: ГГГГ-ММ-ДДTЧЧ:ММ:СС+ЧЧ:ММ. Пример: 2024-05-07T14:14:49+03:00 (Московское время 07.05.2024 14:14:49) |
| delta | Нет | Временной интервал в секундах для поиска звонков по запросу как [ts - delta; ts + delta] | Возможные значения: 0...999. По умолчанию равен 900 |
| Код ответа | Описание |
|---|---|
| 200 | Информация найдена |
| 400 | Ошибка в одном из параметров запроса |
| 403 | Доступ с данного IP-адреса запрещен |
| 404 | Информация не найдена |
| 502 | Узел верификации не запущен |
Ответ с кодом 200 c информацией о звонках содержит тело в формате JSON:
| Параметр | Тип | Описание |
|---|---|---|
| result | строка | Результат выполнения запроса |
| data.a | строка | Телефонный номер вызывающего абонента, переданный в запросе |
| data.b | строка | Телефонный номер вызываемого абонента, переданный в запросе |
| data.ts | строка | Время совершения вызова, переданное в запросе |
| data.delta | целое число | Временной интервал в секундах для поиска звонков, переданный в запросе |
| data.calls | массив | Список найденных звонков |
| data.calls[].cg_number | строка | Телефонный номер вызывающего абонента |
| data.calls[].cd_number | строка | Телефонный номер вызываемого абонента |
| data.calls[].origin_number | строка | Номер, используемый для переадресации |
| data.calls[].generic_number | строка | Дополнительный номер вызывающего абонента |
| data.calls[].ts | строка | Дата и время попытки соединения |
| data.calls[].vrf_code | целое число | Код результата верификации |
| data.calls[].vrf_result | строка | Результат верификации |
| data.calls[].action | строка | Статус прохождения вызова |
| data.calls[].action_code | целое число | Код статус прохождения вызова |
| data.calls[].call_id | строка | Идентификатор вызова |
| data.calls[].id_src | целое число | Идентификатор оператора связи - источника вызова, в соответствии с таблицей OPR |
| data.calls[].id_dst | целое число | Идентификатор оператора связи - получателя вызова, в соответствии с таблицей OPR |
| data.calls[].vrf_id | целое число | Идентификатор сессии верификации |
| data.calls[].uvr_t | целое число | Идентификатор узла верификации вызывающего абонента |
| data.calls[].duration | целое число | Длительность вызова в секундах |
| data.calls[].q850_code | целое число | Код отбоя |
Пример запроса и ответа:
$ curl https://afXX.tlstr.ru/uXXXX/call/history?a=79817775299&b=78122210819&ts=2024-07-02T08:45:00+03:00&delta=600 | jq
{
"result": "found",
"data": {
"a": "79817775299",
"b": "78122210819",
"ts": "2024-07-02T05:45:00+00:00",
"delta": 600,
"calls": [
{
"cg_number": "79817775299",
"cd_number": "78122210819",
"origin_number": "",
"generic_number": "",
"ts": "2024-07-02T05:45:58+00:00",
"vrf_code": 0,
"vrf_result": "Call has been confirmed",
"action": "Call allowed",
"action_code": 0,
"call_id": "328414e3-b2d9-123d-5a97-0242ac11003e",
"id_src": 11369,
"vrf_id": 1158017466123681800,
"uvr_t": 9
}
]
}
}
Ответ с кодом 400 содержит тело в формате JSON:
| Параметр | Тип | Описание |
|---|---|---|
| result | строка | Результат выполнения запроса |
| message | строка | Дополнительные сведения |
| data.a | строка | Телефонный номер, переданный в запросе |
| data.b | строка | Телефонный номер, переданный в запросе |
| data.ts | строка | Время совершения вызова, переданный в запросе |
| data.delta | целое число | Временной интервал, переданный в запросе |
Ответ с кодом 404 содержит тело в формате JSON:
| Параметр | Тип | Описание |
|---|---|---|
| result | строка | Результат выполнения запроса |
| data.a | строка | Телефонный номер, переданный в запросе |
| data.b | строка | Телефонный номер, переданный в запросе |
| data.ts | строка | Время совершения вызова, переданный в запросе |
| data.delta | целое число | Временной интервал, переданный в запросе |
Пример запроса и ответа:
$ curl https://afXX.tlstr.ru/uXXXX/call/history?a=79817775299&b=78122210819&ts=2024-07-02T08:45:00+03:00&delta=600 | jq
{
"result": "not found",
"data": {
"a": "79817775299",
"b": "78122210819",
"ts": "2024-07-02T05:45:00+00:00",
"delta": 600
}
}
Верификация или регистрация вызова (вариант 2)
Данный метод используется для регистрации вызовов в ИС Антифрод. Для входящих вызовов также будет выполнена их верификация.
| Метод | Путь |
|---|---|
| POST | https://afXX.tlstr.ru/uXXXX/call/h/call |
| Параметр | Обязательное | Описание | Возможные значения и примеры |
|---|---|---|---|
| a | Да | Номер вызывающего абонента, в формате E.164 | Пример: 79251234567 |
| b | Да | Номер вызываемого абонента, в формате E.164 | Пример: 79251234567 |
| c | Нет | Номер, используемый для переадресации, в формате E.164 | Пример: 79251234567 |
| d | Нет | Дополнительный номер абонента, в формате E.164 | Пример: 79251234567 |
| call_id | Нет | Идентификатор соединения (вызова). | Текстовая строка, длиной до 100 символов. Приводится в случае наличия такого идентификатора. Заполняется оператором связи при наличии соответствующего поля (например call_id в SIP и т.п.) в протоколе сигнализации. Обязательно указывается, если необходима регистрация дополнительных сведений дополнительным запросом. |
| id_src | Да | Идентификатор оператора связи, из сети которого поступил вызов, определяется по идентификатору пира | Пример: 11463 |
| id_dst | Нет | Идентификатор оператора связи, на сеть которого будет отправлен вызов, определяется по идентификатору пира | Пример: 11463 |
| dbg | Нет | Признак отладки | 1 - в заголовке X-Error-Messages будет возвращена подробная отладочная информация |
| Код ответа | Описание |
|---|---|
| 200 | Вызов прошел верификацию и зарегистрирован в ИС Антифрод |
| 201 | Вызов зарегистрирован в ИС Антифрод |
| 400 | Ошибка в одном из параметров запроса |
| 403 | Доступ с данного IP-адреса запрещен |
| 404 | Вызов не найден на узле верификации оператора вызывающего абонента |
| 502 | Узел верификации не запущен |
В ответах с кодом 400 в информационном заголовке X-Error-Bits передаются биты ошибок.
Пример запроса:
curl -X POST https://afXX.tlstr.ru/uXXXX/call/h/call -d "a=78123332332&b=74958770000&call_id=c_00001&id_src=11463&id_dst=11463&dbg=1"
Регистрация дополнительных сведений о вызове (вариант 2)
Данный метод используется для регистрации дополнительных сведений о ранее зарегистрированном вызове, которые стали известны после его совершения.
Перед использованием данного метода необходимо согласовать с поддержкой ТелеСтор значение временного интервала, в течение которого разрешено регистрировать дополнительные сведения о ранее зарегистрированном вызове.
| Метод | Путь |
|---|---|
| POST | https://afXX.tlstr.ru/uXXXX/call/h/callUpdate |
| Параметр | Обязательное | Описание | Возможные значения и примеры |
|---|---|---|---|
| call_id | Да | Идентификатор соединения (вызова). | Текстовая строка, длиной до 100 символов. |
| id_src | Нет | Идентификатор оператора связи, из сети которого поступил вызов, определяется по идентификатору пира | Пример: 11463 |
| id_dst | Нет | Идентификатор оператора связи, на сеть которого будет отправлен вызов, определяется по идентификатору пира | Пример: 11463 |
| dur | Нет | Длительность вызова в секундах | |
| rc | Нет | Код отбоя в соответствии с Q.850 | Пример: 16 |
| dbg | Нет | Признак отладки | 1 - в заголовке X-Error-Messages будет возвращена подробная отладочная информация |
| Код ответа | Описание |
|---|---|
| 200 | Сведения зарегистрированы в ИС Антифрод |
| 400 | Ошибка в одном из параметров запроса |
| 403 | Доступ с данного IP-адреса запрещен |
| 404 | Вызов с указанным call_id не найден |
| 502 | Узел верификации не запущен |
В ответах с кодом 400 в информационном заголовке X-Error-Bits передаются биты ошибок.
Пример запроса:
curl -X POST https://afXX.tlstr.ru/uXXXX/call/h/callUpdate -d "call_id=c_00001&id_dst=11463&dur=100&rc=16&dbg=1"
Проверка доступности узла верификации
Данный метод используется для проверки доступности узла верификации.
| Метод | Путь |
|---|---|
| GET/POST | https://afXX.tlstr.ru/uXXXX/call/h/ping |
| Код ответа | Описание |
|---|---|
| 200 | Узел верификации доступен |
| 403 | Доступ с данного IP-адреса запрещен |
| 502 | Узел верификации не запущен |
Пример запроса:
curl https://afXX.tlstr.ru/uXXXX/call/h/ping
Верификация вызова (вариант 3)
Данный метод используется для верификации и регистрации входящих вызовов в ИС Антифрод.
| Метод | Путь |
|---|---|
| POST | https://afXX.tlstr.ru/uXXXX/call/h/CheckCall |
| Параметр | Обязательное | Описание | Возможные значения и примеры |
|---|---|---|---|
| a | Да | Номер вызывающего абонента, в формате E.164 | Пример: 79251234567 |
| b | Да | Номер вызываемого абонента, в формате E.164 | Пример: 79251234567 |
| c | Нет | Номер, используемый для переадресации, в формате E.164 | Пример: 79251234567 |
| d | Нет | Дополнительный номер абонента, в формате E.164 | Пример: 79251234567 |
| call_id | Да | Идентификатор соединения (вызова). | Текстовая строка, длиной до 100 символов. Приводится в случае наличия такого идентификатора. Заполняется оператором связи при наличии соответствующего поля (например call_id в SIP и т.п.) в протоколе сигнализации. Обязательно указывается, если необходима регистрация дополнительных сведений дополнительным запросом. |
| id_src | Нет | Идентификатор оператора связи, из сети которого поступил вызов, определяется по идентификатору пира | Пример: 11463 |
| id_dst | Нет | Идентификатор оператора связи, на сеть которого будет отправлен вызов, определяется по идентификатору пира | Пример: 11463 |
| dbg | Нет | Признак отладки | 1 - в заголовке X-Error-Messages будет возвращена подробная отладочная информация |
| Код ответа | Описание |
|---|---|
| 200 | Вызов прошел верификацию и зарегистрирован в ИС Антифрод |
| 400 | Ошибка в одном из параметров запроса |
| 403 | Доступ с данного IP-адреса запрещен |
| 404 | Вызов не найден на узле верификации оператора вызывающего абонента |
| 502 | Узел верификации не запущен |
В ответах с кодом 400 в информационном заголовке X-Error-Bits передаются биты ошибок.
Пример запроса:
curl -X POST https://afXX.tlstr.ru/uXXXX/call/h/CheckCall -d "a=78123332332&b=74958770000&call_id=c_00001&id_src=11463&id_dst=11463&dbg=1"
Регистрация вызова (вариант 3)
Данный метод используется для регистрации исходящих вызовов в ИС Антифрод без выполнения верификации.
| Метод | Путь |
|---|---|
| POST | https://afXX.tlstr.ru/uXXXX/call/h/RegisterCall |
| Параметр | Обязательное | Описание | Возможные значения и примеры |
|---|---|---|---|
| a | Да | Номер вызывающего абонента, в формате E.164 | Пример: 79251234567 |
| b | Да | Номер вызываемого абонента, в формате E.164 | Пример: 79251234567 |
| c | Нет | Номер, используемый для переадресации, в формате E.164 | Пример: 79251234567 |
| d | Нет | Дополнительный номер абонента, в формате E.164 | Пример: 79251234567 |
| call_id | Нет | Идентификатор соединения (вызова). | Текстовая строка, длиной до 100 символов. Приводится в случае наличия такого идентификатора. Заполняется оператором связи при наличии соответствующего поля (например call_id в SIP и т.п.) в протоколе сигнализации. Обязательно указывается, если необходима регистрация дополнительных сведений дополнительным запросом. |
| id_dst | Нет | Идентификатор оператора связи, на сеть которого будет отправлен вызов, определяется по идентификатору пира | Пример: 11463 |
| dbg | Нет | Признак отладки | 1 - в заголовке X-Error-Messages будет возвращена подробная отладочная информация |
| Код ответа | Описание |
|---|---|
| 201 | Вызов зарегистрирован в ИС Антифрод |
| 400 | Ошибка в одном из параметров запроса |
| 403 | Доступ с данного IP-адреса запрещен |
| 502 | Узел верификации не запущен |
В ответах с кодом 400 в информационном заголовке X-Error-Bits передаются биты ошибок.
Пример запроса:
curl -X POST https://afXX.tlstr.ru/uXXXX/call/h/RegisterCall -d "a=78123332332&b=74958770000&call_id=c_00001&id_dst=11463&dbg=1"