چت‌ها
هر عملیات در این گروه: آنچه می‌پذیرد، آنچه برمی‌گرداند و خطاهایی که ممکن است با آن‌ها پاسخ دهد.
عملیات‌ها
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