Teletype Public API (1.2.1)

Download OpenAPI specification:Download

Общая информация

Вы можете использовать данную документацию для ознакомления с методами API. Описание произведено в формате Swagger 3.0. Для генерации базового кода для работы с API на удобном для вас языке программирования воспользуйтесь утилитой Swagger Codegen или online сервисом Swagger Editor.

По всем вопросам работы с API обращайтесь к нам по email: p@teletype.app

Авторизация

Для работы с API необходимо получить токен авторизации — отдельный для каждого проекта в панели Teletype.

Подключаем Public API в настройках проекта в панели Teletype и получаем API Token для авторизации
Выполняем запросы к API с заголовком X-Auth-Token: <ACCESS_TOKEN>
или передаем его в качестве GET-параметра ?token=<ACCESS_TOKEN>

Время действия токена неограничено. Сгенерировать новый токен вы в любой момент можете в настройках панели Teletype. При этом старый токен прекратит свое действие.

Сообщения

Методы API для работы с сообщениями в диалогах

Получение списка сообщений

Возвращает список сообщений отсортированый в порядке убывания даты отправки сообщения с группировкой по диалогам

query Parameters

token required	string Токен для авторизации
page	integer Текущая страница
pageSize	integer Количество данных на странице
dialogId	string Идентификатор диалога
channelId	string Идентификатор канала
clientId	string Идентификатор клиента

header Parameters

X-Auth-Token

required

string

Токен для авторизации

Responses

Response samples

200

Content type

application/json

{"success": true,
"data": {"currentPage": 0,
"totalItems": 0,
"totalPages": 0,
"pageSize": 0,
"items": [{"id": "string",
"dialogId": "string",
"sessionId": "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": "string",
"name": "string"
},
"status": 0,
"type": 0,
"providerd": 0,
"isItClient": true,
"seen": true,
"createdAt": {"date": "2019-05-30T18:03:57+00:00",
"timezone": "UTC"
},
"sentAt": {"date": "2019-05-30T18:03:57+00:00",
"timezone": "UTC"
},
"isGroupChat": true
}
]
},
"errors": [{"code": 401,
"message": "Your request was made with invalid credentials."
}
]
}

Отправка сообщения

Позволяет отправить сообщение с опциональным вложением медиафайла в диалог с клиентом по ID диалога.

Важно! Если речь идёт об асинхронном канале, таком как WhatsApp или Telegram по номеру, то метод возвращает статус "заявки" на отправку сообщения. Сам статус успешной или не успешной отправки вернётся через вебхук message status change

query Parameters

token

required

string

Токен для авторизации

header Parameters

X-Auth-Token

required

string

Токен для авторизации

Request Body schema: multipart/form-data

dialogId required	string Идентификатор диалога
text required	string Текст сообщения
file	string <binary> Файл аттачмента
url	string Ссылка на файл аттачмента. Используется если не передан file

Responses

Response samples

200

Content type

application/json

{"success": true,
"data": {"ids": ["string"
]
},
"errors": [{"code": 401,
"message": "Your request was made with invalid credentials."
}
]
}

Клиенты

Методы API для работы с клиентами

Получение списка клиентов

Возврашает список клиентов, с которыми присутствуют диалоги в данном проекте

query Parameters

token required	string Токен для авторизации
page	integer Текущая страница
pageSize	integer Количество данных на странице
clientId	string Идентификатор клиента
clientPhone	string Example: clientPhone=+79161234567 Номер телефона клиента

header Parameters

X-Auth-Token

required

string

Токен для авторизации

Responses

Response samples

200

Content type

application/json

{"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": 401,
"message": "Your request was made with invalid credentials."
}
]
}

Получение последнего диалога клиента

Возвращает диалог с клиентом полученный по дате последнего сообщения по убыванию

query Parameters

token required	string Токен для авторизации
clientId required	string Идентификатор клиента
channelId	string Идентификатор канала
channelType	string Example: channelType=whatsapp Тип канала

header Parameters

X-Auth-Token

required

string

Токен для авторизации

Responses

Response samples

200

Content type

application/json

{"success": true,
"data": {"id": "string",
"sessionId": "string",
"url": "string"
},
"errors": [{"code": 401,
"message": "Your request was made with invalid credentials."
}
]
}

Получение подробных данных клиента

Возвращает подробную информацию о клиенте

path Parameters

clientId

required

string

Идентификатор клиента

query Parameters

token

required

string

Токен для авторизации

header Parameters

X-Auth-Token

required

string

Токен для авторизации

Responses

Response samples

200

Content type

application/json

{"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"
},
"responsibleClient": "string",
"tags": ["string"
],
"instagram": {"id": "string",
"username": "string",
"url": "string"
},
"telegram": {"id": "string",
"username": "string",
"url": null
},
"telegram_bot": {"id": "string",
"username": "string",
"url": null
},
"amo": {"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"
}
],
"customFields": [{ }
],
"location": "string",
"language": "string",
"timezone": "string",
"date": "string",
"userAgent": "string",
"userAgentVersion": "string",
"devicePlatform": "string",
"devicePlatformVersion": "string",
"gender": 0,
"device": "string",
"ip": "string",
"notes": [{"id": "string",
"operator": {"id": "string",
"name": "string",
"isOnline": true,
"isOperator": true,
"avatar": "string",
"avatar_default": "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": 401,
"message": "Your request was made with invalid credentials."
}
]
}

Обновление данных клиента

Возвращает подробную информацию о клиенте

path Parameters

clientId

required

string

Идентификатор клиента

query Parameters

token

required

string

Токен для авторизации

header Parameters

X-Auth-Token

required

string

Токен для авторизации

Request Body schema: application/x-www-form-urlencoded

name	string Имя клиента
phone	string Телефон клиента
email	string E-mail клиента
additional_payload	string Закодированный в json массив содержащий дополнительную информацию о персоне
force_additional_payload	boolean Признак необходимости перезаписать имеющиеся в массиве дополнительной информации данные

Responses

Response samples

200

Content type

application/json

{"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": 401,
"message": "Your request was made with invalid credentials."
}
]
}

Получение информации о кастомных полях клиента

Возвращает подробную информацию о кастомных полях клиента (Подробнее о Кастомных полях читайте в нашем help)

path Parameters

clientId

required

string

Идентификатор клиента

query Parameters

token

required

string

Токен для авторизации

header Parameters

X-Auth-Token

required

string

Токен для авторизации

Responses

Response samples

200

Content type

application/json

{"success": true,
"data": { },
"errors": [{"code": 401,
"message": "Your request was made with invalid credentials."
}
]
}

Изменить кастомное поле клиента

Позволяет изменить любое кастомное поле клиента

path Parameters

clientId

required

string

Идентификатор клиента

query Parameters

token

required

string

Токен для авторизации

header Parameters

X-Auth-Token

required

string

Токен для авторизации

Request Body schema: application/x-www-form-urlencoded

values

Array of objects[ items ]

Responses

Response samples

200

Content type

application/json

{"success": true,
"data": { },
"errors": [{"code": 401,
"message": "Your request was made with invalid credentials."
}
]
}

Диалоги

Методы API для работы с диалогами

Получение списка диалогов

Возвращает список диалогов отсортированный по дате отправки последнего сообщения

query Parameters

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 Тип канала

header Parameters

X-Auth-Token

required

string

Токен для авторизации

Responses

Response samples

200

Content type

application/json

{"success": true,
"data": {"currentPage": 0,
"totalItems": 0,
"totalPages": 0,
"pageSize": 0,
"totalUnanswered": 5,
"items": [{"id": "string",
"lastSessionId": "string",
"operator": {"id": "string",
"name": "string",
"avatar": "string"
},
"client": {"id": "string",
"name": "string",
"avatar": "string"
},
"status": 0,
"statusName": "string",
"channel": {"id": "string",
"type": "string",
"name": "string"
},
"isUnanswered": true,
"seen": true,
"countNewMessages": 0,
"createdAt": {"date": "2019-05-30T18:03:57+00:00",
"timezone": "UTC"
},
"lastMessage": {"id": "string",
"dialogId": "string",
"sessionId": "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": "string",
"name": "string"
},
"status": 0,
"type": 0,
"providerd": 0,
"isItClient": true,
"seen": true,
"createdAt": {"date": "2019-05-30T18:03:57+00:00",
"timezone": "UTC"
},
"sentAt": {"date": "2019-05-30T18:03:57+00:00",
"timezone": "UTC"
},
"isGroupChat": true
},
"lastMessageAt": {"date": "2019-05-30T18:03:57+00:00",
"timezone": "UTC"
},
"isGroupChat": true,
"lastCategoryId": "string"
}
]
},
"errors": [{"code": 401,
"message": "Your request was made with invalid credentials."
}
]
}

Информация о диалоге с клиентом

Получение подробной информации о диалоге

path Parameters

dialogId

required

string

Идентификатор диалога

query Parameters

token

required

string

Токен для авторизации

header Parameters

X-Auth-Token

required

string

Токен для авторизации

Responses

Response samples

200

Content type

application/json

{"success": true,
"data": {"sessionId": "string",
"operator": {"id": "string",
"name": "string",
"avatar": "string"
},
"client": {"id": "string",
"name": "string",
"avatar": "string"
},
"isOpen": true,
"isGroupChat": true,
"isUnanswered": true,
"seen": true,
"countNewMessages": 0,
"channelId": "string",
"categoryId": "string"
},
"errors": [{"code": 401,
"message": "Your request was made with invalid credentials."
}
]
}

Информация о клиентах группового диалога

В случае если передан групповой диалог, возвращает список клиентов внутри этого диалога

path Parameters

dialogId

required

string

Идентификатор диалога

query Parameters

token

required

string

Токен для авторизации

header Parameters

X-Auth-Token

required

string

Токен для авторизации

Responses

Response samples

200

Content type

application/json

{"success": true,
"data": [{"id": "string",
"name": "string",
"avatar": "string",
"phone": "string"
}
],
"errors": [{"code": 401,
"message": "Your request was made with invalid credentials."
}
]
}

Закрытие диалога с клиентом

Переводит диалог с клиентом в статус закрытого

path Parameters

dialogId

required

string

Идентификатор диалога

query Parameters

token

required

string

Токен для авторизации

header Parameters

X-Auth-Token

required

string

Токен для авторизации

Responses

Response samples

200

Content type

application/json

true

Пометить диалог прочитанным

Переводит все сообщения в диалоге в статус прочитанных

path Parameters

dialogId

required

string

Идентификатор диалога

query Parameters

token

required

string

Токен для авторизации

header Parameters

X-Auth-Token

required

string

Токен для авторизации

Responses

Response samples

200

Content type

application/json

true

Назначить оператора на диалог

Переводит все сообщения в диалоге в статус прочитанных

path Parameters

dialogId

required

string

Идентификатор диалога

query Parameters

token

required

string

Токен для авторизации

header Parameters

X-Auth-Token

required

string

Токен для авторизации

Request Body schema: application/x-www-form-urlencoded

operator_id

string

Идентификатор оператора

Responses

Response samples

200

Content type

application/json

true

Создание нового диалога с клиентом

Позволяет создать диалог с клиентом в канале, если до этого переписка с ним отсутствовала. Поддерживается не во всех типах каналов

query Parameters

token

required

string

Токен для авторизации

header Parameters

X-Auth-Token

required

string

Токен для авторизации

Request Body schema: application/x-www-form-urlencoded

channelId required	string Идентификатор канала
clientPhone	string Номер телефона клиента
clientEmail	string Email адрес клиента

Responses

Response samples

200

Content type

application/json

{"success": true,
"data": {"id": "string",
"url": "string"
},
"errors": [{"code": 401,
"message": "Your request was made with invalid credentials."
}
]
}

Пометить диалог отвеченым

Переводит все сообщения в диалоге в статус отвеченных

path Parameters

dialogId

required

string

Идентификатор диалога

query Parameters

token

required

string

Токен для авторизации

header Parameters

X-Auth-Token

required

string

Токен для авторизации

Responses

Response samples

200

Content type

application/json

{"success": true,
"data": true,
"errors": [{"code": 401,
"message": "Your request was made with invalid credentials."
}
],
"errorType": "UnauthorizedException"
}

Пометить диалог неотвеченым

Переводит все сообщения в диалоге в статус неотвеченных

path Parameters

dialogId

required

string

Идентификатор диалога

query Parameters

token

required

string

Токен для авторизации

header Parameters

X-Auth-Token

required

string

Токен для авторизации

Responses

Response samples

200

Content type

application/json

{"success": true,
"data": true,
"errors": [{"code": 401,
"message": "Your request was made with invalid credentials."
}
],
"errorType": "UnauthorizedException"
}

Каналы

Методы API для работы с каналами

Получение списка каналов

Возвращает список активных каналов в текущем проекте

query Parameters

token required	string Токен для авторизации
page	integer Текущая страница
pageSize	integer Количество данных на странице
channelType	string Example: channelType=whatsapp Тип канала

header Parameters

X-Auth-Token

required

string

Токен для авторизации

Responses

Response samples

200

Content type

application/json

{"success": true,
"data": {"currentPage": 0,
"totalItems": 0,
"totalPages": 0,
"pageSize": 0,
"items": [{"id": "string",
"name": "string",
"type": "string",
"state": "string",
"dialogCount": 0,
"creationStep": 0,
"source": {"phone": "string",
"username": "string",
"email": "string",
"group_id": "string"
}
}
]
},
"errors": [{"code": 401,
"message": "Your request was made with invalid credentials."
}
]
}

Отправка сообщения

Метод одновременного создания/поиска экземпляра диалога и отправки в него сообщения. Поддерживает автоматическое закрытие диалогов.

query Parameters

token

required

string

Токен для авторизации

header Parameters

X-Auth-Token

required

string

Токен для авторизации

Request Body schema: multipart/form-data

channelId required	string Идентификатор канала
clientPhone	string Телефон получателя
clientEmail	string Email получателя
clientUsername	string Username получателя
autoClose	boolean Default: false Закрыть диалог после отправки
text required	string Текст сообщения
file	string <binary> Файл аттачмента
url	string Ссылка на файл аттачмента. Используется если не передан file

Responses

Response samples

200

Content type

application/json

{"success": true,
"data": {"dialog": {"id": "id1",
"url": "https://www.example.com"
},
"messages": ["id1",
"id2"
]
},
"errors": [{"code": 401,
"message": "Your request was made with invalid credentials."
}
],
"errorType": "UnauthorizedException"
}

Категории

Методы API для работы с категориями

Получение списка категорий

Возвращает список категорий в текущем проекте

query Parameters

token

required

string

Токен для авторизации

header Parameters

X-Auth-Token

required

string

Токен для авторизации

Responses

Response samples

200

Content type

application/json

{"success": true,
"data": [{"id": "sTj9vLQatrXkiIgzfTgIWx0ce5Dk7jxirzfhZflVfcKD2kObFHCulcWvSZogU_k5",
"category": "Нужна техническая поддержка",
"projectId": "JeV3g0xzsMlXF-aVhrb0HvXu6LjhkpGFWYJXtxaai3skLzqkhWtn35jKkhCuc6Te",
"description": "Категория обращений, в которых требуется помощь технического специалиста"
}
],
"errors": [{"code": 401,
"message": "Your request was made with invalid credentials."
}
],
"errorType": "UnauthorizedException"
}

Назначить категорию диалогу

Назначает указанную категорию указанному диалогу

path Parameters

dialogId

required

string

Example: 5yJfWXjEluy3cvaHvF6QMqCgRhkHQV7BbZkWZDdwgSqH_lfLhxp2H1XVcYitXg_O

Идентификатор диалога

query Parameters

token

required

string

Токен для авторизации

header Parameters

X-Auth-Token

required

string

Токен для авторизации

Request Body schema: application/x-www-form-urlencoded

category_appointed_id

string

Идентификатор категории

Responses

Response samples

200

Content type

application/json

{"success": true,
"data": true,
"errors": [{"code": 401,
"message": "Your request was made with invalid credentials."
}
],
"errorType": "UnauthorizedException"
}

Заметки

Методы API для работы с заметками

Получение списка заметок о клиенте

Возвращает список всех заметок, которые были оставлены о клиенте

query Parameters

token required	string Токен для авторизации
clientId required	string Идентификатор клиента

header Parameters

X-Auth-Token

required

string

Токен для авторизации

Responses

Response samples

200

Content type

application/json

{"success": true,
"data": {"id": "string",
"operator": {"id": "string",
"name": "string",
"isOnline": true,
"isOperator": true,
"avatar": "string",
"avatar_default": "string"
},
"person_id": "string",
"text": "string",
"created_at": "2022-07-25T08:43:05+00:00"
},
"errors": [{"code": 401,
"message": "Your request was made with invalid credentials."
}
]
}

Создаёт заметку

Создаём заметку для указанного клиента

path Parameters

clientId

required

string

Идентификатор клиента

query Parameters

token

required

string

Токен для авторизации

header Parameters

X-Auth-Token

required

string

Токен для авторизации

Request Body schema: application/x-www-form-urlencoded

text	string Текст заметки

Responses

Response samples

200

Content type

application/json

{"success": true,
"data": {"id": "string"
},
"errors": [{"code": 401,
"message": "Your request was made with invalid credentials."
}
]
}

Удаление заметки о клиенте

Удаляет заметку

path Parameters

noteId

required

string

Идентификатор заметки

query Parameters

token

required

string

Токен для авторизации

header Parameters

X-Auth-Token

required

string

Токен для авторизации

Responses

Response samples

200

Content type

application/json

{"success": true,
"data": true,
"errors": [{"code": 401,
"message": "Your request was made with invalid credentials."
}
]
}

Шаблоны сообщений

Методы API для работы с шаблоными сообщений

Получение информации о шаблоных сообщений внутри проекта

Возвращает информация о шаблонах быстрых ответов.

query Parameters

token

required

string

Токен для авторизации

header Parameters

X-Auth-Token

required

string

Токен для авторизации

Responses

Response samples

200

Content type

application/json

{"success": true,
"data": {"directories": [{"id": "quO8o71RK7zEd8uaAjKpLKvfaXETy7a48QqiK4KGc_d_qfTFancol3lVPoUIUaIh",
"name": "Отработка возражений",
"projectId": "JeV3g0xzsMlXF-aVhrb0HvXu6LjhkpGFWYJXtxaai3skLzqkhWtn35jKkhCuc6Te",
"description": "Шаблоны быстрых ответов, которые помогут отработать самые частые возражения клиентов",
"templates": [{"id": "ESY7r7CbMPI2Hbg5saf6Vc2hWmu-TL0ssZCDqxfHTjN7l_Lgb1byHdoPwbV_T_Vb",
"key": "Дорого",
"text": "Понимаю, что цена может показаться вам высокой. Но ценность всё равно выше, наш продукт поможет вам быстро увеличить прибыль и окупит свою стоимость. Когда вам было бы удобно записаться на демо?",
"directoryId": "quO8o71RK7zEd8uaAjKpLKvfaXETy7a48QqiK4KGc_d_qfTFancol3lVPoUIUaIh",
"type": 20,
"typeName": "edna_waba_operator_template",
"forChannel": "EoRCzgY9rqcxpvN4VRSN9s7satT-Q2dQ1Vv7VFFkjaN1rRFZrezyXStFIBo2QVws"
}
]
}
],
"withoutDirectories": {"templates": [{"id": "ESY7r7CbMPI2Hbg5saf6Vc2hWmu-TL0ssZCDqxfHTjN7l_Lgb1byHdoPwbV_T_Vb",
"key": "Дорого",
"text": "Понимаю, что цена может показаться вам высокой. Но ценность всё равно выше, наш продукт поможет вам быстро увеличить прибыль и окупит свою стоимость. Когда вам было бы удобно записаться на демо?",
"directoryId": "quO8o71RK7zEd8uaAjKpLKvfaXETy7a48QqiK4KGc_d_qfTFancol3lVPoUIUaIh",
"type": 20,
"typeName": "edna_waba_operator_template",
"forChannel": "EoRCzgY9rqcxpvN4VRSN9s7satT-Q2dQ1Vv7VFFkjaN1rRFZrezyXStFIBo2QVws"
}
]
}
},
"errors": [{"code": 401,
"message": "Your request was made with invalid credentials."
}
]
}

Получение информации о папках шаблонов быстрых ответов

Возвращает информация о папках шаблонов быстрых ответов внутри проекта

query Parameters

token

required

string

Токен для авторизации

header Parameters

X-Auth-Token

required

string

Токен для авторизации

Responses

Response samples

200

Content type

application/json

{"success": true,
"data": [{"id": "quO8o71RK7zEd8uaAjKpLKvfaXETy7a48QqiK4KGc_d_qfTFancol3lVPoUIUaIh",
"name": "Отработка возражений",
"projectId": "JeV3g0xzsMlXF-aVhrb0HvXu6LjhkpGFWYJXtxaai3skLzqkhWtn35jKkhCuc6Te",
"description": "Шаблоны быстрых ответов, которые помогут отработать самые частые возражения клиентов"
}
],
"errors": [{"code": 401,
"message": "Your request was made with invalid credentials."
}
]
}

Вебхуки

В этом разделе описаны события, которые будут отправляться на ваш Вебхук URL. Указать данный урл Вы можете в настройках API вашего проекта в панели Teletype.

ВАЖНО! Все события будут передаваться на один URL.. Ниже описание идёт так, как если бы они отправлялись на разные url, но это особенность отображения документации.

Событие поступления нового сообщения от клиента

Событие отправляет на указанный в проекте Webhook данные о новом сообщении от клиента.

Параметр payload содержит сериализованный массив с информацией о сообщении

Request Body schema: multipart/form-data

name required	string new message
required	object (message)

Responses

Response samples

200

Content type

text/plain

Событие об успешной отправке сообщения

Событие отправляет на указанный в проекте Webhook уведомление об успешной отправке оператором сообщения клиенту.

Параметр payload содержит сериализованный массив с идентификаторами отправленного сообщения и диалога, в который оно отправлено

Request Body schema: multipart/form-data

name required	string success send
required	object Сериализованный массив с данными события

Responses

Response samples

200

Content type

text/plain

Событие о статусе отправки сообщения

Событие отправляет на указанный в проекте Webhook уведомление о статусе отправленного сообщения клиенту.

Параметр payload содержит сериализованный массив с идентификаторами отправленного сообщения и диалога, в который оно отправлено

Request Body schema: multipart/form-data

name required	string message status change
required	object Сериализованный массив с данными события

Responses

Response samples

200

Content type

text/plain

Событие о создании новой заметки

Событие отправляет на указанный в проекте Webhook уведомление о создании новой заметки в диалоге.

Параметр payload содержит сериализованный массив с идентификаторами клиента, диалога, заметки и самим текстом заметки

Request Body schema: multipart/form-data

name required	string new note
required	object Сериализованный массив с данными события

Responses

Response samples

200

Content type

text/plain

Событие о закрытии диалога

Событие отправляет на указанный в проекте Webhook уведомление о закрытии диалога.

Параметр payload содержит сериализованный массив с идентификатором диалога, данными клиента, канала, последнего обращения, категории и даты создания диалога

Request Body schema: multipart/form-data

name required	string close dialog
required	object Сериализованный массив с данными события

Responses

Response samples

200

Content type

text/plain

Событие о создании нового диалога

Событие отправляет на указанный в проекте Webhook уведомление о создании нового диалога.

Параметр payload содержит сериализованный массив с идентификатором диалога, данными клиента, канала и даты создания диалога

Request Body schema: multipart/form-data

name required	string new dialog
required	object Сериализованный массив с данными события

Responses

Response samples

200

Content type

text/plain

Событие об открытии старого диалога

Событие отправляет на указанный в проекте Webhook уведомление об открытии старого диалога.

Параметр payload содержит сериализованный массив с идентификатором диалога, данными клиента, канала и даты создания диалога

Request Body schema: multipart/form-data

name required	string open dialog
required	object Сериализованный массив с данными события

Responses

Response samples

200

Content type

text/plain

Событие об изменении данных персоны

Событие отправляет на указанный в проекте Webhook уведомление об изменении данных персоны.

Параметр payload содержит сериализованный массив с данными персоны

Request Body schema: multipart/form-data

name required	string person change
required	object Сериализованный массив с данными события

Responses

Response samples

200

Content type

text/plain

Событие об оценке диалога персоной

Событие отправляет на указанный в проекте Webhook уведомление об оценке диалога персоной.

Параметр payload содержит сериализованный массив с идентификаторами диалога, обращения, оператора, клиента и оценки

Request Body schema: multipart/form-data

name required	string appeal rate
required	object Сериализованный массив с данными события

Responses

Response samples

200

Content type

text/plain

Событие об обновлении шаблонов сообщений

Событие отправляет на указанный в проекте Webhook уведомление об обновлении шаблонов сообщений.

Параметр payload содержит пустой массив

Request Body schema: multipart/form-data

name required	string messages templates updated
payload required	array Пустой массив

Responses

Response samples

200

Content type

text/plain

Событие об изменении активного оператора по обращению

Событие отправляет на указанный в проекте Webhook уведомление об изменении активного оператора по обращению.

Параметр payload содержит сериализованный массив с идентификаторами диалога, обращения, данными канала и оператора

Request Body schema: multipart/form-data

name required	string session operator changed
required	object Сериализованный массив с данными события

Responses

Response samples

200

Content type

text/plain

Project

Получение информации о балансе внутри прокта

Возвращает информация о текущем балансе, количестве оплаченных или триальных дней

query Parameters

token

required

string

Токен для авторизации

header Parameters

X-Auth-Token

required

string

Токен для авторизации

Responses

Response samples

200

Content type

application/json

{"success": true,
"data": {"balance": 1000,
"paidUntilDate": "2022-05-30",
"promoDaysRemain": 0,
"promoEndDate": "2019-05-30",
"promisedPayment": 0
},
"errors": [{"code": 401,
"message": "Your request was made with invalid credentials."
}
]
}

Получение информации об операторах подключенных в проекте

Возвращает информация об операторах присутствующих внутри проекта

query Parameters

token

required

string

Токен для авторизации

header Parameters

X-Auth-Token

required

string

Токен для авторизации

Responses

Response samples

200

Content type

application/json

{"success": true,
"data": [{"id": "string",
"email": "string",
"status": 0,
"name": "string",
"last_name": "string",
"timezone": "UTC",
"language": "string",
"roles": ["string"
]
}
],
"errors": [{"code": 401,
"message": "Your request was made with invalid credentials."
}
]
}

Информация о статусе API

Возвращает подробную информацию о состоянии pubclic api текущего проекта

query Parameters

token

required

string

Токен для авторизации

header Parameters

X-Auth-Token

required

string

Токен для авторизации

Responses

Response samples

200

Content type

application/json

{"success": true,
"data": {"projectId": "string",
"webhookUrl": "string",
"activeWebhooks": ["string"
],
"webhookErrorsCount": 0
},
"errors": [{"code": 401,
"message": "Your request was made with invalid credentials."
}
]
}

Информация о тарифе

Возвращает подробную о тарифе внутри проекта

query Parameters

token

required

string

Токен для авторизации

header Parameters

X-Auth-Token

required

string

Токен для авторизации

Responses

Response samples

200

Content type

application/json

{"success": true,
"data": {"project": {"id": "JeV3g0xzsMlXF-aVhrb0HvXu6LjhkpG3WYJXtxaai3skLzqkhWtn35jKkhCuc6Te",
"owner_id": "h9iuoSjqZ0mN5V7otRCAOA9XxQuqx7P7CFJ-ntaxPIhkF-zNy3Ba76RE6ZuWUCIB",
"name": "ООО Лучшая Компания",
"domain": "thebestcompany",
"url": "https://thebestcompany.teletype.app",
"createdAt": {"date": "2024-07-25T08:43:05+00:00",
"timezone": "UTC"
}
},
"active": true,
"paid": true,
"dailyPayment": 99700,
"dailyPaymentByPrice": 99700,
"balance": {"total": 0
},
"promoDaysGranted": 3,
"promoDaysRemain": 0,
"promoEndDate": {"date": "2024-04-08T06:52:11+00:00",
"timezone": "UTC"
},
"packagePrice": [{"code": 40,
"available": true,
"type": "support-bot-activation",
"count": 300,
"price": 80000,
"duration": 365
}
],
"options": {"operators": {"category": "multiple",
"price": {"1": 8500
},
"promoPrice": "null",
"count": 5
},
"groups": {"category": "multiple",
"price": {"1": 8500
},
"promoPrice": "null",
"count": 5
},
"telegram-bot-application": {"category": "multiple",
"price": {"1": 8500
},
"promoPrice": "null",
"count": 5
},
"online-chat": {"category": "multiple",
"price": {"1": 8500
},
"promoPrice": "null",
"count": 5
},
"whatsapp": {"category": "multiple",
"price": {"1": 8500
},
"promoPrice": "null",
"count": 5
},
"telegram-bot": {"category": "multiple",
"price": {"1": 8500
},
"promoPrice": "null",
"count": 5
},
"vk": {"category": "multiple",
"price": {"1": 8500
},
"promoPrice": "null",
"count": 5
},
"facebook": {"category": "multiple",
"price": {"1": 8500
},
"promoPrice": "null",
"count": 5
},
"viber": {"category": "multiple",
"price": {"1": 8500
},
"promoPrice": "null",
"count": 5
},
"email": {"category": "multiple",
"price": {"1": 8500
},
"promoPrice": "null",
"count": 5
},
"instagram-comments": {"category": "multiple",
"price": {"1": 8500
},
"promoPrice": "null",
"count": 5
},
"statistic": {"category": "multiple",
"price": {"1": 8500
},
"promoPrice": "null",
"count": 5
},
"messages-templates": {"category": "multiple",
"price": {"1": 8500
},
"promoPrice": "null",
"count": 5
},
"amo-crm": {"category": "multiple",
"price": {"1": 8500
},
"promoPrice": "null",
"count": 5
},
"telegram-notifier": {"category": "multiple",
"price": {"1": 8500
},
"promoPrice": "null",
"count": 5
},
"telegram": {"category": "multiple",
"price": {"1": 8500
},
"promoPrice": "null",
"count": 5
},
"instagram-direct": {"category": "multiple",
"price": {"1": 8500
},
"promoPrice": "null",
"count": 5
},
"branding-link": {"category": "multiple",
"price": {"1": 8500
},
"promoPrice": "null",
"count": 5
},
"bitrix24": {"category": "multiple",
"price": {"1": 8500
},
"promoPrice": "null",
"count": 5
},
"public-api": {"category": "multiple",
"price": {"1": 8500
},
"promoPrice": "null",
"count": 5
},
"roistat": {"category": "multiple",
"price": {"1": 8500
},
"promoPrice": "null",
"count": 5
},
"whatsapp-free": {"category": "multiple",
"price": {"1": 8500
},
"promoPrice": "null",
"count": 5
},
"instagram-comments-business": {"category": "multiple",
"price": {"1": 8500
},
"promoPrice": "null",
"count": 5
},
"whatsapp-phone": {"category": "multiple",
"price": {"1": 8500
},
"promoPrice": "null",
"count": 5
},
"avito": {"category": "multiple",
"price": {"1": 8500
},
"promoPrice": "null",
"count": 5
},
"messengers-button": {"category": "multiple",
"price": {"1": 8500
},
"promoPrice": "null",
"count": 5
},
"instagram-direct-business": {"category": "multiple",
"price": {"1": 8500
},
"promoPrice": "null",
"count": 5
},
"moi-sklad": {"category": "multiple",
"price": {"1": 8500
},
"promoPrice": "null",
"count": 5
},
"joinposter": {"category": "multiple",
"price": {"1": 8500
},
"promoPrice": "null",
"count": 5
},
"yclients": {"category": "multiple",
"price": {"1": 8500
},
"promoPrice": "null",
"count": 5
},
"sber-crm": {"category": "multiple",
"price": {"1": 8500
},
"promoPrice": "null",
"count": 5
},
"vk-direct": {"category": "multiple",
"price": {"1": 8500
},
"promoPrice": "null",
"count": 5
},
"sipuni": {"category": "multiple",
"price": {"1": 8500
},
"promoPrice": "null",
"count": 5
},
"categories": {"category": "multiple",
"price": {"1": 8500
},
"promoPrice": "null",
"count": 5
},
"teletype-sender": {"category": "multiple",
"price": {"1": 8500
},
"promoPrice": "null",
"count": 5
},
"tags": {"category": "multiple",
"price": {"1": 8500
},
"promoPrice": "null",
"count": 5
},
"whatsapp-edna": {"category": "multiple",
"price": {"1": 8500
},
"promoPrice": "null",
"count": 5
}
},
"packages": [{"id": "sXGwXtpyzph4-imNdWfx9bfi0vsUApB9t4pwdCLlp8nyaEAPVlBOgZ9H4CuHrmNy",
"type": 10,
"typeName": "support-bot-activation ",
"allowedCount": 300,
"currentCount": 214,
"period": 365,
"price": 80000,
"active": true,
"autoRenew": true,
"createdAt": {"date": "2024-07-25T08:43:05+00:00",
"timezone": "UTC"
},
"activatedAt": {"date": "2024-07-25T08:43:05+00:00",
"timezone": "UTC"
},
"deactivatedAt": {"date": "2024-07-25T08:43:05+00:00",
"timezone": "UTC"
}
}
],
"autopayEnabled": true,
"autopayBalance": 100000,
"autopayAmount": 1000000,
"cardNumber": 3428,
"cardType": "MIR",
"paidEntities": {"operators": ["3QMa5NlOyv0LBQ9StiLRtun9zmN9zM5U4YETgV959X2zMLBumLxd-MxtBSnAPkd8"
],
"groups": true,
"online-chat": ["EeVl5R_AoDicrzjTk_rdThGdeo3hW6Y6D-knt7sEFU6JDDF54X_5EXDz_ls5J0kN"
],
"whatsapp": ["k9cyGcYeZmKAhK29GbZuRVfsSTrW98OISdXbWOCk3b71UFRYBJEe8Unqpkp_9wzj"
],
"vk": ["0xqZW9DmYJhb9FfAWQeeVo_BmQudmLtQNIdOX0-EVKwO-A6-WEvYRlMswiuRgIJV"
],
"facebook": ["FbT7paehuoMl8N8ls0RbjfHbpsaf5RznwHZnWacfhnHC_tAFbWRzCdYzXj6ngF8K"
],
"viber": ["ViF7paehuoMl8N8ls0RbjfHbpsaf5RznwHZnWacfhnHC_tAFbWRzCdYzXj6ngV1B"
],
"email": ["HU7KA45XVbjzkupWCZlv3T8qaPj7NIpxhJa8GGTFj-R3fGvdGsRRKOVyUK87hHFg"
],
"statistic": true,
"messages-templates": true,
"amo-crm": ["AmC5paehuoMl8N8ls0RbjfHbpsaf5RznwHZnWacfhnHC_tAFbWRzCdYzXj6ngA2M"
],
"telegram-notifier": true,
"telegram": ["dBt7paehuoMl8N8ls0RbjfHbpsaf5RznwHZnWacfhnHC_tAFbWRzCdYzXj6ngY1B"
],
"branding-link": false,
"bitrix24": ["idrhfBN75MyuaWxfhmPT914GRL4cmYq5IU5EOvU5yk_ooBzm5d4BZ6LZSZJOymSl"
],
"public-api": true,
"roistat": false,
"instagram-comments-business": ["BcF7paehuoMl8N8ls0RbjfHbpsaf5RznwHZnWacfhnHC_tAFbWRzCdYzXj6ngI3H"
],
"whatsapp-phone": false,
"avito": ["AtF7paehuoMl8N8ls0RbjfHbpsaf5RznwHZnWacfhnHC_tAFbWRzCdYzXj6ngA9N"
],
"messengers-button": ["BtF7paehuoMl8N8ls0RbjfHbpsaf5RznwHZnWacfhnHC_tAFbWRzCdYzXj6ngB3K"
],
"instagram-direct-business": ["IdB7paehuoMl8N8ls0RbjfHbpsaf5RznwHZnWacfhnHC_tAFbWRzCdYzXj6ngI6O"
],
"moi-sklad": ["MsF7paehuoMl8N8ls0RbjfHbpsaf5RznwHZnWacfhnHC_tAFbWRzCdYzXj6ngM2P"
],
"sber-crm": ["ScF7paehuoMl8N8ls0RbjfHbpsaf5RznwHZnWacfhnHC_tAFbWRzCdYzXj6ngS4T"
],
"vk-direct": ["VkD7paehuoMl8N8ls0RbjfHbpsaf5RznwHZnWacfhnHC_tAFbWRzCdYzXj6ngV3Y"
],
"sipuni": ["SpF7paehuoMl8N8ls0RbjfHbpsaf5RznwHZnWacfhnHC_tAFbWRzCdYzXj6ngS9E"
],
"categories": true,
"teletype-sender": false,
"tags": true,
"whatsapp-edna": ["9fmycXZPepjl3EURE7ejd8Q1nIB0U2UUZCtFDgJvahPs2AEy5cPfh_gt0nK88YDW"
],
"telegram-bot": ["I_Ez6M7Y3Bu64es2gWVq62EUsOAEIwBcm5yxb00vDJqT2pn_oFPPGY0zqx45cAI3"
],
"instagram-direct": ["string"
],
"instagram-comments": ["string"
],
"joinposter": ["string"
],
"yclients": ["string"
],
"whatsapp-free": ["string"
],
"telegram-bot-application": false
},
"promisedPayment": 0
},
"errors": [{"code": 401,
"message": "Your request was made with invalid credentials."
}
]
}

Настройки публичного API проекта

Редактирование настроек публичного API проекта

query Parameters

token

required

string

Токен для авторизации

header Parameters

X-Auth-Token

required

string

Токен для авторизации

Request Body schema: application/json

active_webhooks	Array of strings Список активных типов вебхуков для проекта
api_webhook	string Новое значение для Public API вебхука

Responses

Request samples

Payload

Content type

application/json

{"active_webhooks": ["new message",
"success send",
"message status change",
"new note",
"new dialog",
"open dialog",
"close dialog",
"person change",
"appeal rate",
"messages templates updated",
"session operator changed"
],
"api_webhook": "https://example.com/webhook"
}

Response samples

200

Content type

application/json

{"success": true,
"data": true,
"errors": [{"code": 401,
"message": "Your request was made with invalid credentials."
}
],
"errorType": "UnauthorizedException"
}