imconnector.delete.messages
Удалить отправленные сообщения
Описание
Метод imconnector.delete.messages удаляет сообщения из открытой линии, которые были переданы внешней системой.
Метод работает только в контексте приложения.
В параметрах метода используются значения внешней системы: идентификатор пользователя, идентификатор сообщения и идентификатор чата или канала.
Для удаления передавайте message.id и chat.id, которые использовали при отправке сообщений методом imconnector.send.messages.
Параметры
CONNECTOR
string
обязательный
Строковый код коннектора, который задали в параметре ID при вызове imconnector.register
LINE
integer
обязательный
Идентификатор открытой линии.
Идентификатор можно получить методами imopenlines.config.get и imopenlines.config.list.get
MESSAGES
array
обязательный
Массив сообщений для удаления. Каждый элемент массива — объект сообщения с тремя обязательными блоками: user, message, chat. Структура объекта подробно описана ниже
Параметр MESSAGES
user
object
необязательный
Данные пользователя внешней системы.
Структура объекта подробно описана ниже
message
object
необязательный
Данные сообщения внешней системы.
Структура объекта подробно описана ниже
chat
object
необязательный
Данные чата или канала внешней системы.
Структура объекта подробно описана ниже
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"CONNECTOR": "myconnector",
"LINE": 107,
"MESSAGES": [
{
"user": {"id": "ext-user-42"},
"message": {"id": "ext-msg-1001"},
"chat": {"id": "channel-123"}
}
],
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/imconnector.delete.messages
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type DeleteMessagesResult = {
SUCCESS: boolean
DATA: {
RESULT: Array<{
user: string
message: { id: string; date?: number; text?: string; files?: unknown[] }
chat: { id: string; description?: string }
SUCCESS: boolean
ERRORS?: string[]
}>
}
}
try {
const response = await $b24.actions.v2.call.make<DeleteMessagesResult>({
method: 'imconnector.delete.messages',
params: {
CONNECTOR: 'myconnector',
LINE: 107,
MESSAGES: [
{
user: { id: 'ext-user-42' },
message: { id: 'ext-msg-1001' },
chat: { id: 'channel-123' },
},
],
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info(result.SUCCESS, result.DATA.RESULT)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function deleteMessages() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'imconnector.delete.messages',
params: {
CONNECTOR: 'myconnector',
LINE: 107,
MESSAGES: [
{
user: { id: 'ext-user-42' },
message: { id: 'ext-msg-1001' },
chat: { id: 'channel-123' },
},
],
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info(result.SUCCESS, result.DATA.RESULT)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', deleteMessages)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.imconnector.delete.messages(
connector="myconnector",
line=107,
messages=[
{
"user": {
"id": "ext-user-42",
},
"message": {
"id": "ext-msg-1001",
},
"chat": {
"id": "channel-123",
},
},
],
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
$result = $b24Service->core->call(
'imconnector.delete.messages',
[
'CONNECTOR' => 'myconnector',
'LINE' => 107,
'MESSAGES' => [
[
'user' => ['id' => 'ext-user-42'],
'message' => ['id' => 'ext-msg-1001'],
'chat' => ['id' => 'channel-123'],
],
],
]
);
BX24.callMethod(
'imconnector.delete.messages',
{
CONNECTOR: 'myconnector',
LINE: 107,
MESSAGES: [
{
user: { id: 'ext-user-42' },
message: { id: 'ext-msg-1001' },
chat: { id: 'channel-123' },
},
],
},
function(result) {
console.log(result.data());
}
);
$result = CRest::call(
'imconnector.delete.messages',
[
'CONNECTOR' => 'myconnector',
'LINE' => 107,
'MESSAGES' => [
[
'user' => ['id' => 'ext-user-42'],
'message' => ['id' => 'ext-msg-1001'],
'chat' => ['id' => 'channel-123'],
],
],
]
);
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "imconnector.delete.messages", b24.Params{
"CONNECTOR": "myconnector",
"LINE": 107,
"MESSAGES": []b24.Params{
{
"user": b24.Params{
"id": "ext-user-42",
},
"message": b24.Params{
"id": "ext-msg-1001",
},
"chat": b24.Params{
"id": "channel-123",
},
},
},
})
if err != nil {
return fmt.Errorf("imconnector.delete.messages: %w", err)
}
var item struct {
Success bool `json:"SUCCESS"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.Success)
Ответ
HTTP-статус: 200
{
"result": {
"SUCCESS": true,
"DATA": {
"RESULT": [
{
"user": "585",
"message": {
"id": "ext-msg-1001"
},
"chat": {
"id": "channel-123"
},
"SUCCESS": true
}
]
}
},
"time": {
"start": 1773267564,
"finish": 1773267565.070724,
"duration": 1.0707240104675293,
"processing": 1,
"date_start": "2026-03-11T14:19:24+03:00",
"date_finish": "2026-03-11T14:19:25+03:00",
"operating_reset_at": 1773268164,
"operating": 0.113616943359375
}
}
Возвращаемые данные
SUCCESS
boolean
Возвращает true в случае успешного удаления сообщения
DATA
object
Данные обработки сообщений.
Структура объекта подробно описана ниже
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "ERROR_ARGUMENT",
"error_description": "Argument 'CONNECTOR' is null or empty"
}
| Код | Описание | Значение |
|---|---|---|
403 |
WRONG_AUTH_TYPE |
Current authorization type is denied for this method Application context required |
400 |
ERROR_ARGUMENT |
Argument 'CONNECTOR' is null or empty |
400 |
ERROR_ARGUMENT |
Argument 'LINE' is null or empty |
400 |
ERROR_ARGUMENT |
Argument 'MESSAGES' is null or empty |
400 |
NOT_ACTIVE_LINE |
Линия c таким ID неактивна или не существует |
400 |
IMCONNECTOR_NO_CORRECT_PROVIDER |
Не удалось найти подходящий провайдер для коннектора |

