Чаты
Каждая операция этой группы: что она принимает, что возвращает и какими ошибками может ответить.
Операции
The conversations held with the assistant in the app, as the Chats page lists them. Only the workspace owner reaches the chats: an API key, or an app the owner connected with every address. An access token acting for a member is a 403 owner_only, and a key or an app limited to particular addresses or domains is a 422 capability_unsupported.
GET/chats
List the assistant chats
The chats of the workspace, newest first, a page at a time, each with its title, how many messages it holds and when it last changed. q searches the titles and sort orders them. Only the workspace owner reaches the chats: an API key, or an app the owner connected with every address. An access token acting for a member is a 403 owner_only, and a key or an app limited to particular addresses or domains is a 422 capability_unsupported.
Requires the threads:read scope.
Параметры запроса
qstringSearch the titles.
До 200 символовsortstringnewestandoldestorder by the last change, andtitlealphabetically.Одно из"newest""oldest""title"По умолчанию"newest"limitintegerRows per page, 1 to 100.
Не меньше 1Не больше 100По умолчанию25cursorstringThe previous page's
nextCursor, passed back as it came. It is opaque: it holds where the last row sat in this list's order, so a row deleted or edited between pages never breaks the walk, and the next page starts at the first row that sorts after it. A value this list did not hand out is a 400invalid_cursor.
Возвращает
A page of chats.
Ошибки
Ошибки, которые может вернуть любая операция400401403404422500Каталог ошибок
Также доступно в
GET/chats/{id}
Retrieve a chat
One chat by id. Only the workspace owner reaches the chats: an API key, or an app the owner connected with every address. An access token acting for a member is a 403 owner_only, and a key or an app limited to particular addresses or domains is a 422 capability_unsupported.
Requires the threads:read scope.
Параметры пути
idstringОбязательноThe chat id from
GET /chats.
Возвращает
The chat.
Ошибки
Ошибки, которые может вернуть любая операция400401403404422500Каталог ошибок
Также доступно в
PATCH/chats/{id}
Rename a chat
Gives the chat a new title. Only the workspace owner reaches the chats: an API key, or an app the owner connected with every address. An access token acting for a member is a 403 owner_only, and a key or an app limited to particular addresses or domains is a 422 capability_unsupported.
Requires the threads:write scope.
Параметры пути
idstringОбязательноThe chat id from
GET /chats.
Тело запроса
titlestringОбязательно- От 1 до 120 символов
Возвращает
The chat with its new title.
Ошибки
Ошибки, которые может вернуть любая операция400401403404422500Каталог ошибок
Также доступно в
DELETE/chats/{id}
Delete a chat
Deletes the chat and every message in it, for good. Nothing it did in the mailbox is undone. Only the workspace owner reaches the chats: an API key, or an app the owner connected with every address. An access token acting for a member is a 403 owner_only, and a key or an app limited to particular addresses or domains is a 422 capability_unsupported.
Requires the threads:write scope.
Параметры пути
idstringОбязательноThe chat id from
GET /chats.
Возвращает
Deleted.
Ошибки
Ошибки, которые может вернуть любая операция400401403404422500Каталог ошибок
Также доступно в
Объекты
Chatobject
objectstringОбязательно- Одно из
"chat" idstringОбязательноtitlestringОбязательноkindstringОбязательно- Одно из
"chat" messageCountintegerОбязательно- Не меньше 0
updatedAtstringОбязательноWhen a message last arrived in it.
Форматdate-time
ChatListobject
objectstring- Одно из
"list" dataChat[]hasMorebooleanTrue when another page follows. Pass
nextCursorback ascursorto read it.nextCursorstringAn opaque cursor for the next page, or null on the last page. Pass it back unchanged.
Может быть null
DeletedChatobject
objectstring- Одно из
"chat" idstringdeletedboolean- Одно из
true