Sohbetler
Bu gruptaki her işlem: neyi kabul ettiği, ne döndürdüğü ve hangi hatalarla yanıt verebileceği.
İşlemler
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.
Sorgu parametreleri
qstringSearch the titles.
En çok 200 karaktersortstringnewestandoldestorder by the last change, andtitlealphabetically.Şunlardan biri"newest""oldest""title"Varsayılan"newest"limitintegerRows per page, 1 to 100.
En az 1En çok 100Varsayılan25cursorstringThe 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.
Döndürür
A page of chats.
Hatalar
Her işlemin döndürebileceği hatalar400401403404422500Hata kataloğu
Şurada da var
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.
Yol parametreleri
idstringZorunluThe chat id from
GET /chats.
Döndürür
The chat.
Hatalar
Her işlemin döndürebileceği hatalar400401403404422500Hata kataloğu
Şurada da var
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.
Yol parametreleri
idstringZorunluThe chat id from
GET /chats.
İstek gövdesi
titlestringZorunlu- 1 ile 120 karakter arası
Döndürür
The chat with its new title.
Hatalar
Her işlemin döndürebileceği hatalar400401403404422500Hata kataloğu
Şurada da var
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.
Yol parametreleri
idstringZorunluThe chat id from
GET /chats.
Döndürür
Deleted.
Hatalar
Her işlemin döndürebileceği hatalar400401403404422500Hata kataloğu
Şurada da var
Nesneler
Chatobject
objectstringZorunlu- Şunlardan biri
"chat" idstringZorunlutitlestringZorunlukindstringZorunlu- Şunlardan biri
"chat" messageCountintegerZorunlu- En az 0
updatedAtstringZorunluWhen a message last arrived in it.
Biçimdate-time
ChatListobject
objectstring- Şunlardan biri
"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 olabilir
DeletedChatobject
objectstring- Şunlardan biri
"chat" idstringdeletedboolean- Şunlardan biri
true