チャット
このグループのすべてのオペレーションの、受け付ける内容、返す内容、返しうるエラー。
オペレーション
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