Skip to content

Add coach

Подключение тренера к разговору

Метод add.coach
Версия API v4.0
Описание Подключение тренера к разговору
Вернуться к списку методов

Метод позволяет подключить к разговору тренера, который задан в личном кабинете или указан в параметре phone_number

Параметры запроса

Название Тип Обязательный Описание
access_token string да Ключ сессии аутентификации
call_session_id number да Уникальный идентификатор сессии звонка, который может быть получен в ответном сообщении при вызове методов start.vnumber_call, start.scenario_call, start.employee_call, с помощью сервера уведомлений или DATA API.
phone_number string нет Номер тренера, если не используется тренер указанный в личном кабинете.
Если номер тренера не задан, то подключается тренер из настроек сотрудника в личном кабинете

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

{
  "jsonrpc": "2.0",
  "method": "add.coach",
  "id": "req1",
  "params": {
    "access_token": "2fRN4g217ca0b4224a67988aff3e584f91964a692045415f36fa66146f5a3c1ae1f6093d",
    "call_session_id": 27934036,
    "phone_number": "79260000000"
  }
}

Пример ответа

{
  "jsonrpc": "2.0",
  "id": "req1",
  "result": {
    "data": {
      "success": "true"
    }
  }
}

Список возвращаемых ошибок

Текст ошибки Код ошибки Мнемоника ошибки Описание
The coach not found in your settings -32602 coach_not_found
The phone number does not exist or inactive -32602 no_active_phone_number

См. также раздел "Список ошибок общих для всех методов"