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

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

Ограничение

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

Запрос

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

Query-параметры

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

Заголовки

Authorization: OAuth <токен>

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

curl -X GET \
  -H "Authorization: OAuth <токен>" \
  "https://botapi.messenger.yandex.net/bot/v1/users/getUserLink?login=userlogin"

Результат

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

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

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

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

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

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

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

{
  "ok": false,
  "description": "User not found"
}
Предыдущая
Управление участниками чата или канала
Следующая
Отправка текстового сообщения