Получение ссылок на пользователя

Метод позволяет получить ссылки, по которым можно открыть диалог (приватный чат) с пользователем или позвонить ему.

HTTP метод: GET

URL: https://botapi.messenger.yandex.net/bot/v1/users/getUserLink/

Заголовки

Authorization: OAuth <токен>
Content-Type: application/json

Тело запроса (JSON)

Имя параметра Обязательный Тип Описание Ограничения, значение по умолчанию
login Да string Логин пользователя

Ограничения

Бот может возвращать ссылки только на пользователей из организации, в которой состоят и он, и пользователь, по которому запрашивается информация.

Результат

Результатом успешного запроса является ответ с кодом 200 и телом с JSON, в котором содержится информация о ссылках на пользователя.

Имя параметра Обязательный Тип Описание
ok Да boolean Флаг успешности выполнения
id Да string ID пользователя в мессенджере
chat_link Да string Ссылка на чат с пользователем
call_link Да string Ссылка на звонок пользователю

В случае ошибки возвращается соответствующий статус HTTP. Описание ошибки приходит в поле description.

Имя параметра Обязательный Тип Описание
ok Да boolean Флаг успешности выполнения
description Да string Описание ошибки

Пример запроса

curl -X GET -H 'Authorization: OAuth AtXXXXXXXXXXX' -H "Content-Type: application/json" 'https://botapi.messenger.yandex.net/bot/v1/users/getUserLink?login=userlogin'

Пример успешного ответа

{"ok": true, "id": "someuserid", "chat_link": "https://yandex.ru/chat#/user/someuserid", "call_link": "messenger://call/create/private?user_id=someuserid"}

Пример ответа с ошибкой

{"ok": false, "description": "User not found"}