GET /api/v1/forward/channels
認証済みアカウントが所有する Channel レコードを返します。
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT> |
Query parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channel_type | string | No | - | wechat、qq、wecom、feishu、または dingtalk でフィルターします。 |
enabled | boolean | No | - | 手動での有効状態でフィルターします。 |
binding_status | string | No | - | unbound、bound、または expired でフィルターします。 |
identity_id | string | No | - | Forward Identity ID でフィルターします。 |
template_id | string | No | - | Forward Template ID でフィルターします。 |
limit | integer | No | 20 | 1 ページあたりの件数。最大 100。 |
after_id | string | No | - | 指定した Channel ID より後のレコードを取得するためのカーソル。 |
before_id | string | No | - | 指定した Channel ID より前のレコードを取得するためのカーソル。 |
Example request
Example response
HTTP 200 OKResponse fields
| Field | Type | Description |
|---|---|---|
data | array | 現在のページの Channel オブジェクト。 |
first_id | string|null | このページの最初の Channel の ID。 |
last_id | string|null | このページの最後の Channel の ID。 |
has_more | boolean | さらにレコードが残っているかどうか。 |
Errors
| HTTP | Type | Code | Trigger |
|---|---|---|---|
| 400 | invalid_request_error | invalid_pagination | ページネーションパラメーターが無効です。 |
| 400 | invalid_request_error | channel_type_unsupported | チャネルタイプのフィルターがサポートされていません。 |
| 401 | authentication_error | authentication_required | PAT が無効または期限切れです。 |
Notes
after_idとbefore_idは同時に指定できません。- チャネルは呼び出し元のアカウント境界内でのみ返されます。