カテゴリー
Webhook
Get a single Webhook
単一のWebhookを取得できます。 パラメータ URL https://api.channel.io/open/v5/webhooks/{id}およびHTTP GET経由でアクセス可能 この方法は現在application/jsonのみをサポートしています。 パラメータ 例 要件 説明 タイプ id 1004 必須 WebhookのID Path 例 GET https://api.channel.io/open/v5/webhooks/1004 レスポンス Webhookオブジェクトを返します。 { "webhook": { "id": "string", "channelId": "string", "name": "string", "url": "string", "token": "string", "createdAt": 1656032153401, "scopes": [ "userChatOpened" ], "apiVersion": "string", "lastBlockedAt": 1656032153401, "blocked": true } }
List of Webhooks
Webhookオブジェクトのリストを取得できます。 パラメータ URL https://api.channel.io/open/v5/webhooksおよびHTTP GET経由でアクセス可能 この方法は現在application/jsonのみをサポートしています。 パラメータ 例 要件 説明 タイプ since 123124122 任意 最初に取得するメッセージのエポックタイム（マイクロ秒単位） Query limit 25 任意 取得するWebフックの最大数を制限 Query 例 GET https://api.channel.io/open/v5/webhooks レスポンス Webhookオブジェクトのリストを返します。 { "next": 1656032153343, "webhooks": [ { "id": "string", "channelId": "string", "name": "string", "url": "string", "token": "string", "createdAt": 1656032153401, "scopes": [ "userCha
Create a Webhook
Webhookオブジェクトを作成できます。 パラメータ URL https://api.channel.io/open/v5/webhooksおよびHTTP POST経由でアクセス可能 POST本文にパラメータを表示します。この方法は現在application/jsonのみサポートしています。 パラメータ 例 要件 説明 タイプ name channelWH 必須 Webhookの名前 Body url http://www.channel.io/ 必須 WebhookのURL Body 例 POST https://api.channel.io/open/v5/webhooks POSTリクエストの本文は次のようになります。 { "name": "string", "url": "string", "scopes": [ "userChatOpened" ], "apiVersion": "string", "blocked": true } レスポンス 新しく作成されたWebhookオブジェクトを返します。 { "webhook": { "id": "string", "chann
Update a Webhook
Webhookオブジェクトのフィールドを更新できます。 パラメータ URL https://api.channel.io/open/v5/webhooks/{id}およびHTTP PATCH経由でアクセス可能 この方法は現在application/jsonのみサポートしています。 パラメータ 例 要件 説明 タイプ id 12345 必須 WebhookオブジェクトのID Path (property) (name) 任意 Webhookのプロパティ Body 例 PATCH https://api.channel.io/open/v5/webhooks/12345 PATCH本文は次のようになります。 { "name":"string", "url":"string", "scopes":[ "userChatOpened" ], "apiVersion":"string", "blocked":true } レスポンス 変更されたWebhookオブジェクトを返します。 { "webhook": { "id": "string", "channelId": "string", "na
Delete a Webhook
Webhookオブジェクトを削除できます。 パラメータ URL https://api.channel.io/open/v5/webhooks/{id}およびHTTP DELETE経由でアクセス可能 パラメータ 例 要件 説明 タイプ id 12345 必須 WebhookのID 12345 例 DELETE https://api.channel.io/open/v5/webhooks/12345 レスポンス 成功した場合、HTTPステータスコード204を返します。