Bisedat
Çdo veprim në këtë grup: çfarë pranon, çfarë kthen dhe gabimet me të cilat mund të përgjigjet.
Veprimet
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.
Parametrat e pyetjes
qstringSearch the titles.
Deri në 200 karakteresortstringnewestandoldestorder by the last change, andtitlealphabetically.Një nga"newest""oldest""title"Parazgjedhja"newest"limitintegerRows per page, 1 to 100.
Të paktën 1Më së shumti 100Parazgjedhja25cursorstringThe 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.
Kthen
A page of chats.
Gabimet
Gabimet që mund të kthejë çdo veprim400401403404422500Katalogu i gabimeve
E disponueshme edhe në
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.
Parametrat e shtegut
idstringE detyrueshmeThe chat id from
GET /chats.
Kthen
The chat.
Gabimet
Gabimet që mund të kthejë çdo veprim400401403404422500Katalogu i gabimeve
E disponueshme edhe në
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.
Parametrat e shtegut
idstringE detyrueshmeThe chat id from
GET /chats.
Trupi i kërkesës
titlestringE detyrueshme- Nga 1 deri në 120 karaktere
Kthen
The chat with its new title.
Gabimet
Gabimet që mund të kthejë çdo veprim400401403404422500Katalogu i gabimeve
E disponueshme edhe në
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.
Parametrat e shtegut
idstringE detyrueshmeThe chat id from
GET /chats.
Kthen
Deleted.
Gabimet
Gabimet që mund të kthejë çdo veprim400401403404422500Katalogu i gabimeve
E disponueshme edhe në
Objektet
Chatobject
objectstringE detyrueshme- Një nga
"chat" idstringE detyrueshmetitlestringE detyrueshmekindstringE detyrueshme- Një nga
"chat" messageCountintegerE detyrueshme- Të paktën 0
updatedAtstringE detyrueshmeWhen a message last arrived in it.
Formatidate-time
ChatListobject
objectstring- Një nga
"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.
Mund të jetë null
DeletedChatobject
objectstring- Një nga
"chat" idstringdeletedboolean- Një nga
true