Авторизация пользователя по номеру телефона
Реализовать авторизацию пользователя по номеру телефона в телефонии Novofon можно с помощью метода API из нашего нового Call API. И делается это следующим образом:
В открытом API есть метод start.informer_call
URL, по которому отправлять запрос: https://callapi-jsonrpc.novofon.ru/v4.0
Запросы к API выполняются всегда с помощью метода POST
Параметры метода
Параметры метода, которые вам понадобятся для работы:
- access_token - ваш ключ аутентификации, который вы можете получить в личном кабинете в разделе Пользователи АТС - Администратор - редактирование пользователя - API, в этом разделе активируйте использование ключей API и затем вам нужно сгенерировать Secret - именно он используется в этом параметре.
- virtual_phone_number - виртуальный номер, арендуемый вами. Формат номера должен соответствовать международному стандарту E.164 (например, 74951270777). Всегда используется в качестве номера звонящего при звонке на номер, указанный в параметре contact. Виртуальные номера можно получить с помощью REST API метода из нашего Data API get.virtual_numbers
- contact - номер абонента на который совершается вызов. Формат номера должен соответствовать международному стандарту E.164 (например, 79091234567).
- contact_message - определяет параметры сообщения, которое необходимо проиграть абоненту заданному в параметре contact
- type - определяет тип сообщения. media - файл или tts - текст для услуги синтеза речи Text-to-Speech
- value - если поле type имеет значение media, то в качестве значения принимается идентификатор файла для проигрывания. Файл для проигрывания может быть системным или пользовательским. Идентификатор файла для проигрывания можно получить с помощью метода DATA API - Получение списка медиафайлов Если поле type имеет значение tts, то в качестве значения принимается текст для синтезирования его в голосовое сообщение.
Пример запроса в формате JSON:
{
"jsonrpc": "2.0",
"id": "req1",
"method": "start.informer_call",
"params": {
"access_token": "2fRN4g217ca0b4224a67988aff3e584f91964a692045415f36fa66146f5a3c1ae1f6093d",
"virtual_phone_number": "74951270777",
"contact": "79260000000",
"contact_message": {
"type": "tts",
"value": "Добрый день. Ваш код авторизации 0 1 2 3 4 5. Повторяю 0 1 2 3 4 5"
}
}
}
Пример ответа:
{
"jsonrpc": "2.0",
"id": "req1",
"result": {
"data": {
"call_session_id": 1238694
}
}
}
Подробнее с нашей документацией по работе с Call API вы можете ознакомиться здесь: https://novofon.github.io/call_api/
С Data API здесь: https://novofon.github.io/data_api/