Hold call
Постановка вызова на удержание
| Метод | hold.call |
|---|---|
| Версия API | v4.0 |
| Описание | Постановка вызова на удержание |
| Вернуться к списку методов | |
Параметры запроса
| Название | Тип | Обязательный | Допустимые значения | Описание | |
|---|---|---|---|---|---|
| access_token | string | да | Ключ сессии аутентификации | ||
| call_session_id | number | да | Уникальный идентификатор сессии звонка, который может быть получен в ответном сообщении при вызове методов start.vnumber_call, start.scenario_call, start.employee_call, с помощью сервера уведомлений или DATA API. | ||
| Проигрывание сообщения вызывающему абоненту | |||||
| contact_message | object | да |
Определяет параметры сообщения, которое необходимо проиграть вызывающему абоненту.
Вызывающий абонент - это номер, указанный в параметре contact в методах
start.informer_call,
start.vnumber_call,
start.scenario_call,
start.employee_call или абонент позвонивший на виртуальную АТС.
|
||
| type | string | да | media, tts |
Определяет тип сообщения. |
|
| value | string | да |
Если поле Если поле Длина TTS сообщения регулируется тарифным планом и установленным лимитом. |
||
Пример запроса
Копировать
{
"jsonrpc": "2.0",
"method": "hold.call",
"id": "req1",
"params": {
"access_token": "2fRN4g217ca0b4224a67988aff3e584f91964a692045415f36fa66146f5a3c1ae1f6093d",
"call_session_id": 23465781,
"contact_message": {
"type": "media",
"value": "2034"
}
}
}
Пример ответа
Копировать
{
"jsonrpc": "2.0",
"id": "req1",
"result": {
"data": {
"success": "true"
}
}
}
Список возвращаемых ошибок
| Текст ошибки | Код ошибки | Мнемоника ошибки | Описание |
|---|---|---|---|
| This method can not be called in this state | -32004 | invalid_state |
Метод может быть вызван только в состоянии Talk (см. Диаграмма состояний звонка) |
The media file with id {media_file_id} not found |
-32602 | media_file_not_found |
|
The maximum length of Text-to-Speech message is {tts_message_max_length}. The length of your message is {sent_tts_message_length} |
-32602 | tts_text_exceeded |
Длина сообщения превысила допустимое ограничение, установленное тарифным планом |
| The character encoding must be UTF-8 | -32602 | character_encoding_not_allowed |
См. также раздел "Список ошибок общих для всех методов"