Teletype Public API (1.0.4)

Download OpenAPI specification:Download

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

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

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

Авторизация

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

  1. Подключаем Public API в настройках проекта в панели Teletype и получаем API Token для авторизации
  2. Выполняем запросы к 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

200

Список сообщений

get /messages

Рабочий сервер

https://api.teletype.app/public/api/v1/messages

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "success": true,
  • "data":
    {
    },
  • "errors":
    [
    ]
}

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

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

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

200

Список идентификаторов созданных сообщений

post /message/send

Рабочий сервер

https://api.teletype.app/public/api/v1/message/send

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "success": true,
  • "data":
    {
    },
  • "errors":
    [
    ]
}

Клиенты

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

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

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

query Parameters
token
required
string

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

page
integer

Текущая страница

pageSize
integer

Количество данных на странице

clientId
string

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

clientPhone
string
Example: clientPhone=%2B79161234567

Номер телефона клиента

header Parameters
X-Auth-Token
required
string

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

Responses

200

Список клиентов

get /clients

Рабочий сервер

https://api.teletype.app/public/api/v1/clients

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "success": true,
  • "data":
    {
    },
  • "errors":
    [
    ]
}

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

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

query Parameters
token
required
string

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

clientId
required
string

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

channelId
string

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

channelType
string
Example: channelType=whatsapp

Тип канала

header Parameters
X-Auth-Token
required
string

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

Responses

200

Диалог клиента

get /client/dialog

Рабочий сервер

https://api.teletype.app/public/api/v1/client/dialog

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "success": true,
  • "data":
    {
    },
  • "errors":
    [
    ]
}

Каналы

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

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

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

query Parameters
token
required
string

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

page
integer

Текущая страница

pageSize
integer

Количество данных на странице

channelType
string
Example: channelType=whatsapp

Тип канала

header Parameters
X-Auth-Token
required
string

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

Responses

200

Список каналов

get /channels

Рабочий сервер

https://api.teletype.app/public/api/v1/channels

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "success": true,
  • "data":
    {
    },
  • "errors":
    [
    ]
}

Вебхуки

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

Все события будут передаваться на один URL.

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

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

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

Request Body schema: multipart/form-data
name
required
string

new message

payload
required
object (message)

Responses

200

Сервер должен вернуть 200 код без содержимого

post /new-message

Рабочий сервер

https://api.teletype.app/public/api/v1/new-message

Response samples

Content type
text/plain
Copy

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

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

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

Request Body schema: multipart/form-data
name
required
string

success send

payload
required
object

Сериализованный массив с данными события

Responses

200

Сервер должен вернуть 200 код без содержимого

post /success-send

Рабочий сервер

https://api.teletype.app/public/api/v1/success-send

Response samples

Content type
text/plain
Copy