Channel Developers

thumbnail
カテゴリー

Group

Get a single Group

groupIdによる取得 idによる単一のGroupオブジェクトの取得が可能です。 パラメータ URL https://api.channel.io/open/v5/groups/{groupId}およびHTTP GET経由でアクセス可能 この方法は現在application/jsonのみをサポートしています。 パラメータ 例 要件 説明 タイプ groupId 1234 必須 GroupオブジェクトのID Path 例 GET https://api.channel.io/open/v5/group/1234 groupNameによる取得 名前で単一のGroupオブジェクトの取得が可能です。 パラメータ URL(https://api.channel.io/open/v5/group/@{groupName})およびHTTP GET経由でアクセス可能 例 GET https://api.channel.io/open/v5/group/@justGroup この方法は現在application/jsonのみサポートしていています。 パラメータ 例 要件 説明 タイプ groupNam
Get a single Group

List of Groups

グループのリスト取得方法です。 Parameter URL https://api.channel.io/open/v5/groupsおよびHTTP GET経由でアクセス可能 この方法は現在application/jsonのみサポートしています。 パラメータ 例 要件 説明 タイプ since 123124122 任意 昇順で取得する最初のグループ名 Query limit 25 任意 結果の最大数を制限 - min : 1 - max : 500 - default : 25 Query 例 GET https://api.channel.io/open/v5/groups レスポンス Groupオブジェクトのリストを返します。 { "next": "string", "groups": [ { "id": "string", "channelId": "string", "name": "string", "scope": "all", "managerIds": [ "string" ], "icon": "string", "description": "string", "c
List of Groups

Get sessions in a Group

groupIdによるセッション取得 Group内のセッションリストをIDで取得できます。 パラメータ URL https://api.channel.io/open/v5/groups/{groupId}/sessionsおよびHTTP GET経由でアクセス可能 この方法は現在application/jsonのみサポートしています。 パラメータ 例 要件 説明 タイプ groupId 1234 必須 GroupのID Path 例 GET https://api.channel.io/open/v5/group/1234/sessions groupNameによるセッション取得 名前を指定して、Group内のセッションリストを取得できます。 パラメータ URL(https://api.channel.io/open/v5/groups/@{groupName}/sessions)およびHTTP GET経由でアクセス可能 この方法は現在application/jsonのみサポートしています。 パラメータ 例 要件 説明 タイプ groupName justgroup 必須 Groupの名
Get sessions in a Group

Get messages in a Group

groupIdによるメッセージ取得 groupIdでGroup内メッセージリストを取得できます。 パラメータ URL https://api.channel.io/open/v5/groups/{groupId}/messagesおよびHTTP GET経由でアクセス可能 この方法は現在application/jsonのみサポートしています。 パラメータ 例 要件 説明 タイプ groupId 1234 必須 GroupのID Path since 1401231818 任意 取得する最初のメッセージのUnixタイムスタンプ値 Query limit 25 任意 結果の最大数を制限 - min : 1 - max : 500 - default : 25 Query sortOrder desc 必須 メッセージの順序(降順は最新のメッセージが先頭 - 利用可能な値 : asc, desc, both - デフォルト値 : desc Query 例 GET https://api.channel.io/open/v5/groups/1234/messages?since=14012318
Get messages in a Group

Send a message to a Group

groupIdによるメッセージ送信 groupIdでGroupにメッセージを送信できます。 パラメータ URL https://api.channel.io/open/v5/groups/{groupId}/messagesおよびHTTP POST経由でアクセス可能 POSTリクエストのボディはMessageオブジェクトである必要があります。この方法は現在application/jsonのみサポートしています。 パラメータ 例 要件 説明 タイプ groupId 1234 必須 GroupのID Path botName channelBot 任意 メッセージを送信するBotの名前 Query 例 POST https://api.channel.io/open/v5/groups/1234/messages?botName=channelBot groupNameによるメッセージ送信 groupNameでGroupに新規メッセージを送信できます。 パラメータ URL(https://api.channel.io/open/v5/groups/@{groupName}/messages
Send a message to a Group

Get a file url in a Group

groupId経由で署名付きファイルURLを取得する 15分後に失効する署名付きファイルURLを取得できます。 パラメータ URL https://api.channel.io/open/v5/groups/{groupId}/messages/fileおよびHTTP GET経由でアクセス可能 この方法は現在application/jsonのみサポートしています。 パラメータ 例 要件 説明 タイプ groupId 1234 必須 GroupのID Path key pub-file/12345/0a1b2c3d4e5f6g7h8i9j/example.txt 必須 FileのKey Query 例 GET https://api.channel.io/open/v5/groups/1234/messages/file?key=pub-file/12345/0a1b2c3d4e5f6g7h8i9j/example.txt 15分後に失効する署名付きファイルURLを取得できます。 パラメータ URL https://api.channel.io/open/v5/groups/@{grou
Get a file url in a Group

Update a Group

groupIdによる更新 idでGroupオブジェクトを更新できます。 パラメータ URL https://api.channel.io/open/v5/group/{groupId}およびHTTP PATCH経由でアクセス可能 この方法は現在application/jsonのみをサポートしています。 パラメータ 例 要件 説明 タイプ groupId 1234 必須 GroupオブジェクトのID Path botName channelBot 任意 メッセージを送信するBotの名前 Query 例 PATCH https://api.channel.io/open/v5/group/1234?botName=channelBot groupNameによる更新 名前でGroupオブジェクトを更新できます パラメータ URL https://api.channel.io/open/v5/group/@{groupName}およびHTTP PATCH経由でアクセス可能 この方法は現在application/jsonのみサポートしています。 パラメータ 例 要件 説明 タイプ groupNa
Update a Group