カテゴリー
UserChat
Get a UserChat
特定のUserChatオブジェクトを取得できます。 パラメータ URL https://api.channel.io/open/v5/user-chats/{userChatId}およびHTTP GET経由でアクセス可能 このメソッドは現在、application/jsonのみを生成します。 パラメータ 例 要件 説明 パラメータの型 userChatId 5e65fa8bc2409f0c1fd3 必須 UserChatのID Path 例 GET https://api.channel.io/open/v5/user-chats/5e65fa8bc2409f0c1fd3 レスポンス 関連情報と共にUserChatオブジェクトを返します。 { "userChat":{ "id":"string", "channelId":"string", "contactKey":"string", "contactOrder":1656032152515, "contactMediumType":"string", "state":"closed", "managed":true, "userId
List of UserChats
管理状態にあるUserChatのリストについてのドキュメントです。 パラメータ URL https://api.channel.io/open/v5/user-chatsおよびHTTP GET経由でアクセス可能 クエリ文字列にパラメータを指定してください。 パラメータ 例 要件 説明 タイプ state opened 必須 ユーザーチャット状態フィルター。利用可能な値：closed, opened, snoozed（デフォルト値：opened）。ユーザーチャット状態フィルター。利用可能な値：closed, opened, snoozed（デフォルト値：opened）。 Query sortOrder desc 必須 ソート順。利用可能な値：asc, desc, both（デフォルト値：desc）。ソート順。利用可能な値：asc, desc, both（デフォルト値：desc）。 Query since eyJjaGF0S2V5IjoiZ3Jvn0= 任意 取得する最初のユーザーチャットのエンコード済みキー取得する最初のユーザーチャットのエンコード済みキー Query limit 40
Get a UserChat's sessions
IDでUserChatのセッション一覧を取得する方法です。 パラメータ URL https://api.channel.io/open/v5/user-chats/{userChatId}/sessionsおよびHTTP GET経由でアクセス可能 この方法は現在、application/jsonのみサポートしています。 パラメータ 例 要件 説明 タイプ userChatId 5e65fa8bc2409f0c1fd3 必須 UserchatのID Path 例 GET https://api.channel.io/open/v5/user-chats/5e65fa8bc2409f0c1fd3/sessions レスポンス セッションと関連情報を返します。 { "sessions": [ { "key": "string", "chatId": "string", "chatKey": "string", "updatedKey": "string", "unreadKey": "string", "channelId": "string", "alert": 0, "unread":
Get a UserChat's messages
IDを持つUserChatのメッセージリストを取得する方法です。 パラメータ URL https://api.channel.io/open/v5/user-chats/{userChatId}/messagesおよびHTTP GET経由でアクセス可能 この方法は現在、application/jsonのみサポートしています。 パラメータ 例 要件 説明 タイプ userChatId 5e65fa8bc2409f0c1fd3 必須 UserChatのID Path since eyJjaGF0S2V5IjoiZ3Jvn0= 任意 取得する最初のメッセージのエンコード済みキー Qeury limit 25 任意 取得するメッセージの最大数を制限 Query sortOrder desc(or asc) 必須 メッセージの表示順序（降順は最新のメッセージを最初に表示） Query 例 GET https://api.channel.io/open/v5/user-chats/5e65fa8bc2409f0c1fd3/messages?limit=10 レスポンス メッセージと関連情報を返しま
Send a message to a UserChat
ボット経由でチャットに新しいメッセージを送信できます。 パラメータ URL https://api.channel.io/open/v5/user-chats/{userChatId}/messagesおよびHTTP POST経由でアクセス可能 メッセージパラメータをPOSTボディで送信してください。この方法は現在application/jsonのみをサポートしています。 パラメータ 例 要件 説明 タイプ userChatId 5e65fa8bc2409f0c1fd3 必須 UserChatのID Path botName Channel-bot 任意 Botの名前 Query 例 POST https://api.channel.io/open/v5/user-chats/5e65fa8bc2409f0c1fd3/messages?botName=channelBot リクエスト POSTボディは以下のようになります。 レスポンス 新しく作成されたメッセージオブジェクトを返します。 { "message": { "chatKey": "string", "id": "string"
Get a file url in a UserChat
Fileキー経由で署名付きファイルURLを取得する 15分後に失効する署名付きファイルURLを取得できます。 パラメータ URL https://api.channel.io/open/v5/user-chats/{userChatId}/messages/fileおよびHTTP GET経由でアクセス可能 この方法は現在application/jsonのみサポートしています。 パラメータ 例 要件 説明 タイプ userChatId 1234 必須 UserChatのID Path key pub-file/12345/0a1b2c3d4e5f6g7h8i9j/example.txt 必須 FileのKey Query 例 GET https://api.channel.io/open/v5/user-chats/1234/messages/file?key=pub-file/12345/0a1b2c3d4e5f6g7h8i9j/example.txt レスポンス 15分後に期限切れになる署名付きファイルURLを返します。 { "result": "String" }
Invite to a UserChat
特定のUserChatに管理者を招待する方法です。 パラメータ URL https://api.channel.io/open/v5/user-chats/{userChatId}/inviteおよびHTTP PATCH経由でアクセス可能 クエリ文字列にパラメータを指定してください。 パラメータ 例 要件 説明 タイプ userChatId 5e65fa8bc2409f0c1fd3 必須 UserChatのID Path botName channelBot 必須 招待するボット名 Query managerIds 1231 必須 チームメンバーID Query 例 PATCH https://api.channel.io/open/v5/user-chats/5e65fa8bc2409f0c1fd3/invite?botName=channelBot&managerIds=141241&managerIds=1231 レスポンス 関連情報と共にUserChatオブジェクトを返します。 { "userChat":{ "id":"string", "channelId":"string"
Close a UserChat
特定のUserChatを閉じる方法です。 パラメータ URL https://api.channel.io/open/v5/user-chats/{userChatId}/closeおよびHTTP PATCH経由でアクセス可能 パラメータ 例 要件 説明 タイプ userChatId 5e65fa8bc2409f0c1fd3 必須 UserChatのID Path botName channelBot 必須 削除するボット名 Query 例 PATCH https://api.channel.io/open/v5/user-chats/5e65fa8bc2409f0c1fd3/close レスポンス { "userChat":{ "id":"string", "channelId":"string", "contactKey":"string", "contactOrder":1656032152515, "contactMediumType":"string", "state":"closed", "managed":true, "userId":"string", "name":"