Изменить текст в центре карточки звонка со стороны приложения CallCardSetStatusText
Scope:
telephonyКто может выполнять метод: любой пользователь
Метод CallCardSetStatusText изменяет текст статуса в центре карточки звонка.
Метод работает в контексте приложения в плейсменте PAGE_BACKGROUND_WORKER.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
PLACEMENT* |
Имя команды интерфейса. Для данного метода — |
|
PARAMS* |
Объект параметров команды. Для данного метода передается объект со свойством |
Параметр PARAMS
|
Название |
Описание |
|
statusText* |
Новый текст статуса в центре карточки |
Примеры кода
Как использовать примеры в документации
Рекомендуется вызывать метод после события BackgroundCallCard::initialized
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"PLACEMENT":"CallCardSetStatusText","PARAMS":{"statusText":"Ожидаем ответ клиента"}}' \
"https://**put_your_bitrix24_address**/rest/placement.call?auth=**put_access_token_here**"
BX24.placement.call(
'CallCardSetStatusText',
{ statusText: 'Ожидаем ответ клиента' },
function(result) {
console.log(result);
}
);
try {
$response = $b24Service
->core
->call(
'placement.call',
[
'PLACEMENT' => 'CallCardSetStatusText',
'PARAMS' => [
'statusText' => 'Ожидаем ответ клиента',
]
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error: ' . $e->getMessage();
}
BX24.callMethod(
'placement.call',
{
PLACEMENT: 'CallCardSetStatusText',
PARAMS: {
statusText: 'Ожидаем ответ клиента'
}
},
function(result)
{
if (result.error())
{
console.error(result.error(), result.error_description());
}
else
{
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'placement.call',
[
'PLACEMENT' => 'CallCardSetStatusText',
'PARAMS' => [
'statusText' => 'Ожидаем ответ клиента',
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
[]
Возвращаемые данные
Пустой массив при успешном вызове.
Обработка ошибок
Ошибка REST-вызова
{
"error": "WRONG_AUTH_TYPE",
"error_description": "Application context required"
}
Ошибка интерфейсного вызова
[
{
"result": "error",
"errorCode": "Call card is undefined"
}
]
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
Application context required |
Метод вызван вне контекста приложения в плейсменте |
|
|
Карточка звонка недоступна |
Нет активной карточки звонка для управления |
|
|
Не передан обязательный параметр |
В десктоп-сценарии поле |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Изменить заголовок карточки звонка со стороны приложения CallCardSetCardTitle
- Выключить микрофон оператора со стороны приложения CallCardSetMute
- Поставить звонок на удержание со стороны приложения CallCardSetHold
- Изменить состояние интерфейса карточки звонка со стороны приложения CallCardSetUiState
- Получить список доступных состояний интерфейса карточки звонка CallCardGetListUiStates
- Закрыть карточку звонка со стороны приложения CallCardClose
- Обзор событий