Skip to content

Latest commit

 

History

History
185 lines (149 loc) · 5.29 KB

imconnector-chat-name-set.md

File metadata and controls

185 lines (149 loc) · 5.29 KB
Raw

Установить новое имя чата imconnector.chat.name.set

Scope: imconnector

Кто может выполнять метод: любой пользователь

Метод устанавливает новое имя чата.

Параметры метода

{% include Сноска об обязательных параметрах %}

#| || Название тип | Описание || || CONNECTOR* string | Идентификатор коннектора || || LINE* string | Идентификатор открытой линии || || CHAT_ID* string | Идентификатор чата во внешней системе || || NAME* string | Новое имя чата || |#

Примеры кода

{% include Сноска о примерах %}

{% list tabs %}

  • cURL (Webhook)

    curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"CONNECTOR":"connector","LINE":"105","CHAT_ID":"47e007b1-ee15-43db-bcba-1c26e5884d3f","NAME":"Новое имя диалога"}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webbhook_here**/imconnector.chat.name.set

  • cURL (OAuth)

    curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"CONNECTOR":"connector","LINE":"105","CHAT_ID":"47e007b1-ee15-43db-bcba-1c26e5884d3f","NAME":"Новое имя диалога","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/imconnector.chat.name.set

  • JS

    var params = {
    CONNECTOR: 'connector',
    LINE: '105',
    CHAT_ID: '47e007b1-ee15-43db-bcba-1c26e5884d3f',
    NAME: 'Новое имя диалога'
};
BX24.callMethod(
    'imconnector.chat.name.set',
    params,
    function(result)
    {
        if(result.error())
            alert("Error: " + result.error());
        else
            alert("Успешно: " + result.data());
    }
);

  • PHP

    require_once('crest.php');

$params = [
    'CONNECTOR' => 'connector',
    'LINE' => '105',
    'CHAT_ID' => '47e007b1-ee15-43db-bcba-1c26e5884d3f',
    'NAME' => 'Новое имя диалога'
];

$result = CRest::call(
    'imconnector.chat.name.set',
    $params
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

{% endlist %}

Обработка ответа

HTTP-статус: 200

{
    "answer": {
        "result": {
            "SUCCESS": true,
            "DATA": {
                "RESULT": {}
            }
        },
        "time": {
            "start": 1732110908.525962,
            "finish": 1732110908.879113,
            "duration": 0.3531508445739746,
            "processing": 0.07694888114929199,
            "date_start": "2024-11-20T15:55:08+02:00",
            "date_finish": "2024-11-20T15:55:08+02:00"
        }
    },
    "query": {
        "method": "imconnector.chat.name.set",
        "data": {
            "CONNECTOR": "newcustomconnector",
            "LINE": "105",
            "CHAT_ID": "1",
            "NAME": "name"
        }
    },
    "status": 200
}

Возвращаемые данные

#| || Название тип | Описание || || SUCCESS boolean | Возвращает true при успешной установке нового имени чата || || DATA object | Содержит объект RESULT c параметрами нового имени чата || |#

Обработка ошибок

HTTP-статус: 400

{
    "error": "NOT_ACTIVE_LINE",
    "error_description": "Линия c таким ID неактивна или не существует"
}

{% include notitle обработка ошибок %}

Возможные коды ошибок

#| || Код | Описание || || NOT_ACTIVE_LINE | Линия c таким ID неактивна или не существует || || IMCONNECTOR_NO_CORRECT_PROVIDER | Не удалось найти подходящий провайдер для коннектора || || ERROR_ARGUMENT | Не указаны обязательные параметры NAME или CHAT_ID || || CHAT_RENAMING_FAILED | Не удалось переименовать чат || |#

{% include системные ошибки %}

Продолжите изучение