Download OpenAPI specification:Download
Вы можете использовать данную документацию для ознакомления с методами API. Описание произведено в формате Swagger 3.0. Для генерации базового кода для работы с API на удобном для вас языке программирования воспользуйтесь утилитой Swagger Codegen или online сервисом Swagger Editor.
По всем вопросам работы с API обращайтесь к нам по email: p@teletype.app
Для работы с API необходимо получить токен авторизации — отдельный для каждого проекта в панели Teletype.
X-Auth-Token: <ACCESS_TOKEN>?token=<ACCESS_TOKEN>Время действия токена неограничено. Сгенерировать новый токен вы в любой момент можете в настройках панели Teletype. При этом старый токен прекратит свое действие.
Возвращает список сообщений отсортированый в порядке убывания даты отправки сообщения с группировкой по диалогам
| token required | string Токен для авторизации |
| page | integer Текущая страница |
| pageSize | integer Количество данных на странице |
| dialogId | string Идентификатор диалога |
| channelId | string Идентификатор канала |
| clientId | string Идентификатор клиента |
| X-Auth-Token required | string Токен для авторизации |
{- "success": true,
- "data": {
- "currentPage": 0,
- "totalItems": 0,
- "totalPages": 0,
- "pageSize": 0,
- "items": [
- {
- "id": "string",
- "dialogId": "string",
- "text": "string",
- "attachments": [
- {
- "id": "string",
- "url": "string",
- "type": "string",
- "filename": "string"
}
], - "operator": {
- "id": "string",
- "name": "string",
- "avatar": "string"
}, - "client": {
- "id": "string",
- "name": "string",
- "avatar": "string"
}, - "channel": {
- "id": "string",
- "type": "whatsapp",
- "name": "string"
}, - "status": 0,
- "type": 0,
- "createdAt": {
- "date": "2019-05-30T18:03:57+00:00",
- "timezone": "UTC"
}, - "isItClient": true
}
]
}, - "errors": [
- {
- "code": 400,
- "message": "string"
}
]
}Позволяет отправить сообщение с опциональным вложением медиафайла в диалог с клиентом по ID диалога.
Важно! Если речь идёт об асинхронном канале, таком как WhatsApp или Telegram по номеру, то метод возвращает статус "заявки" на отправку сообщения. Сам статус успешной или не успешной отправки вернётся через вебхук message status change
| token required | string Токен для авторизации |
| X-Auth-Token required | string Токен для авторизации |
| dialogId required | string Идентификатор диалога |
| text required | string Текст сообщения |
| file | string <binary> Файл аттачмента |
| url | string Ссылка на файл аттачмента. Используется если не передан file |
{- "success": true,
- "data": {
- "ids": [
- "string"
]
}, - "errors": [
- {
- "code": 400,
- "message": "string"
}
]
}Возврашает список клиентов, с которыми присутствуют диалоги в данном проекте
| token required | string Токен для авторизации |
| page | integer Текущая страница |
| pageSize | integer Количество данных на странице |
| clientId | string Идентификатор клиента |
| clientPhone | string Example: clientPhone=+79161234567 Номер телефона клиента |
| X-Auth-Token required | string Токен для авторизации |
{- "success": true,
- "data": {
- "currentPage": 0,
- "totalItems": 0,
- "totalPages": 0,
- "pageSize": 0,
- "items": [
- {
- "id": "string",
- "isOnline": true,
- "lastOnlineAt": "2019-05-30T18:03:57+00:00",
- "phoneIsLocked": true,
- "emailIsLocked": true,
- "banned": true,
- "averageRate": 0,
- "firstMessageAt": "2019-05-30T18:03:57+00:00",
- "lastMessageAt": "2019-05-30T18:03:57+00:00",
- "name": "string",
- "avatar": "string",
- "avatarOriginal": "string",
- "color": "string",
- "animal": "string",
- "phone": "string",
- "email": "string"
}
]
}, - "errors": [
- {
- "code": 400,
- "message": "string"
}
]
}Возвращает диалог с клиентом полученный по дате последнего сообщения по убыванию
| token required | string Токен для авторизации |
| clientId required | string Идентификатор клиента |
| channelId | string Идентификатор канала |
| channelType | string Example: channelType=whatsapp Тип канала |
| X-Auth-Token required | string Токен для авторизации |
{- "success": true,
- "data": {
- "id": "string",
- "url": "string"
}, - "errors": [
- {
- "code": 400,
- "message": "string"
}
]
}Возвращает подробную информацию о клиенте
| clientId required | string Идентификатор клиента |
| token required | string Токен для авторизации |
| X-Auth-Token required | string Токен для авторизации |
{- "success": true,
- "data": {
- "id": "string",
- "isOnline": true,
- "lastOnlineAt": "2019-05-30T18:03:57+00:00",
- "phoneIsLocked": true,
- "emailIsLocked": true,
- "banned": true,
- "averageRate": 0,
- "firstMessageAt": "2019-05-30T18:03:57+00:00",
- "lastMessageAt": "2019-05-30T18:03:57+00:00",
- "name": "string",
- "avatar": "string",
- "avatarOriginal": "string",
- "color": "string",
- "animal": "string",
- "phone": "string",
- "email": "string",
- "vk": {
- "id": "string",
- "url": "string"
}, - "info": {
- "utmSource": "string",
- "utmMedium": "string",
- "utmCampaign": "string",
- "utmTerm": "string",
- "utmContent": "string",
- "referrerUrl": "string",
- "roistatVisit": "string",
- "additionalPayload": "string"
}, - "crmLinks": {
- "amo_crm": "string",
- "bitrix_crm": "string"
}, - "location": "string",
- "language": "string",
- "timezone": "string",
- "userAgent": "string",
- "userAgentVersion": "string",
- "devicePlatform": "string",
- "devicePlatformVersion": "string",
- "gender": "string",
- "device": "string",
- "ip": "string",
- "notes": {
- "id": "string",
- "operator": {
- "id": "string",
- "name": "string",
- "avatar": "string"
}, - "text": "string",
- "created_at": "2019-05-30T18:03:57+00:00"
}, - "pagesHistory": {
- "url": "string",
- "title": "string",
- "channel_id": "string",
- "date": "2019-05-30T18:03:57+00:00"
}, - "appealsHistory": {
- "id": "string",
- "lastMessageAt": "2019-05-30T18:03:57+00:00",
- "channelType": "string",
- "channelName": "string"
}
}, - "errors": [
- {
- "code": 400,
- "message": "string"
}
]
}Возвращает подробную информацию о клиенте
| clientId required | string Идентификатор клиента |
| token required | string Токен для авторизации |
| X-Auth-Token required | string Токен для авторизации |
| name | string Имя клиента |
| phone | string Телефон клиента |
string E-mail клиента | |
| additional_payload | string Закодированный в json массив содержащий дополнительную информацию о персоне |
| force_additional_payload | boolean Признак необходимости перезаписать имеющиеся в массиве дополнительной информации данные |
{- "success": true,
- "data": {
- "id": "string",
- "isOnline": true,
- "lastOnlineAt": "2019-05-30T18:03:57+00:00",
- "phoneIsLocked": true,
- "emailIsLocked": true,
- "banned": true,
- "averageRate": 0,
- "firstMessageAt": "2019-05-30T18:03:57+00:00",
- "lastMessageAt": "2019-05-30T18:03:57+00:00",
- "name": "string",
- "avatar": "string",
- "avatarOriginal": "string",
- "color": "string",
- "animal": "string",
- "phone": "string",
- "email": "string",
- "vk": {
- "id": "string",
- "url": "string"
}, - "info": {
- "utmSource": "string",
- "utmMedium": "string",
- "utmCampaign": "string",
- "utmTerm": "string",
- "utmContent": "string",
- "referrerUrl": "string",
- "roistatVisit": "string",
- "additionalPayload": "string"
}, - "crmLinks": {
- "amo_crm": "string",
- "bitrix_crm": "string"
}, - "location": "string",
- "language": "string",
- "timezone": "string",
- "userAgent": "string",
- "userAgentVersion": "string",
- "devicePlatform": "string",
- "devicePlatformVersion": "string",
- "gender": "string",
- "device": "string",
- "ip": "string",
- "notes": {
- "id": "string",
- "operator": {
- "id": "string",
- "name": "string",
- "avatar": "string"
}, - "text": "string",
- "created_at": "2019-05-30T18:03:57+00:00"
}, - "pagesHistory": {
- "url": "string",
- "title": "string",
- "channel_id": "string",
- "date": "2019-05-30T18:03:57+00:00"
}, - "appealsHistory": {
- "id": "string",
- "lastMessageAt": "2019-05-30T18:03:57+00:00",
- "channelType": "string",
- "channelName": "string"
}
}, - "errors": [
- {
- "code": 400,
- "message": "string"
}
]
}Возвращает список диалогов отсортированный по дате отправки последнего сообщения
| token required | string Токен для авторизации |
| page | integer Текущая страница |
| pageSize | integer Количество данных на странице |
| status | string Default: "all" Enum: "all" "open" "close" Example: status=open Статус диалога |
| channelId | string Идентификатор канала |
| channelType | string Example: channelType=whatsapp Тип канала |
| X-Auth-Token required | string Токен для авторизации |
{- "success": true,
- "data": {
- "currentPage": 0,
- "totalItems": 0,
- "totalPages": 0,
- "pageSize": 0,
- "totalUnanswered": 0,
- "items": [
- {
- "id": "string",
- "operator": {
- "id": "string",
- "name": "string",
- "avatar": "string"
}, - "client": {
- "id": "string",
- "name": "string",
- "avatar": "string"
}, - "status": 0,
- "statusName": "string",
- "channel": {
- "id": "string",
- "type": "whatsapp",
- "name": "string"
}, - "isUnanswered": true,
- "createdAt": {
- "date": "2019-05-30T18:03:57+00:00",
- "timezone": "UTC"
}, - "lastMessage": {
- "id": "string",
- "dialogId": "string",
- "text": "string",
- "attachments": [
- {
- "id": "string",
- "url": "string",
- "type": "string"
}
]
}, - "lastMessageAt": {
- "date": "2019-05-30T18:03:57+00:00",
- "timezone": "UTC"
}
}
]
}, - "errors": [
- {
- "code": 400,
- "message": "string"
}
]
}Получение подробной информации о диалоге
| dialogId required | string Идентификатор диалога |
| token required | string Токен для авторизации |
| X-Auth-Token required | string Токен для авторизации |
{- "success": true,
- "data": {
- "operator": {
- "id": "string",
- "name": "string",
- "avatar": "string"
}, - "client": {
- "id": "string",
- "name": "string",
- "avatar": "string"
}, - "isOpen": true,
- "seen": true,
- "countNewMessages": 0,
- "channelId": "string"
}, - "errors": [
- {
- "code": 400,
- "message": "string"
}
]
}Переводит диалог с клиентом в статус закрытого
| dialogId required | string Идентификатор диалога |
| token required | string Токен для авторизации |
| X-Auth-Token required | string Токен для авторизации |
trueПереводит все сообщения в диалоге в статус прочитанных
| dialogId required | string Идентификатор диалога |
| token required | string Токен для авторизации |
| X-Auth-Token required | string Токен для авторизации |
trueПереводит все сообщения в диалоге в статус прочитанных
| dialogId required | string Идентификатор диалога |
| token required | string Токен для авторизации |
| X-Auth-Token required | string Токен для авторизации |
| operator_id | string Идентификатор оператора |
trueВозвращает список активных каналов в текущем проекте
| token required | string Токен для авторизации |
| page | integer Текущая страница |
| pageSize | integer Количество данных на странице |
| channelType | string Example: channelType=whatsapp Тип канала |
| X-Auth-Token required | string Токен для авторизации |
{- "success": true,
- "data": {
- "currentPage": 0,
- "totalItems": 0,
- "totalPages": 0,
- "pageSize": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "type": "whatsapp",
- "state": "string",
- "dialogCount": 0
}
]
}, - "errors": [
- {
- "code": 400,
- "message": "string"
}
]
}Позволяет создать диалог с клиентом в канале, если до этого переписка с ним отсутствовала. Поддерживается не во всех типах каналов
| token required | string Токен для авторизации |
| X-Auth-Token required | string Токен для авторизации |
| channelId required | string Идентификатор канала |
| clientPhone | string Номер телефона клиента |
| clientEmail | string Email адрес клиента |
{- "success": true,
- "data": {
- "id": "string",
- "url": "string"
}, - "errors": [
- {
- "code": 400,
- "message": "string"
}
]
}В этом разделе описаны события, которые будут отправляться на ваш Вебхук URL. Указать данный урл Вы можете в настройках API вашего проекта в панели Teletype.
Все события будут передаваться на один URL.
Событие отправляет на указанный в проекте Webhook данные о новом сообщении от клиента.
Параметр payload содержит сериализованный массив с информацией о сообщении
| name required | string new message |
required | object (message) |
Событие отправляет на указанный в проекте Webhook уведомление об успешной отправке оператором сообщения клиенту.
Параметр payload содержит сериализованный массив с идентификаторами отправленного сообщения и диалога, в который оно отправлено
| name required | string success send |
required | object Сериализованный массив с данными события |
Событие отправляет на указанный в проекте Webhook уведомление о статусе отправленного сообщения клиенту.
Параметр payload содержит сериализованный массив с идентификаторами отправленного сообщения и диалога, в который оно отправлено
| name required | string message status change |
required | object Сериализованный массив с данными события |
Событие отправляет на указанный в проекте Webhook уведомление о создании новой заметки в диалоге.
Параметр payload содержит сериализованный массив с идентификаторами клиента, диалога, заметки и самим текстом заметки
| name required | string new note |
required | object Сериализованный массив с данными события |
Возвращает информация о текущем балансе, количестве оплаченных или триальных дней
| token required | string Токен для авторизации |
| X-Auth-Token required | string Токен для авторизации |
{- "success": true,
- "data": {
- "balance": 1000,
- "paidUntilDate": "2022-05-30",
- "promoDaysRemain": 0,
- "promoEndDate": "2019-05-30"
}, - "errors": [
- {
- "code": 400,
- "message": "string"
}
]
}