45 lines
1.1 KiB
Markdown
45 lines
1.1 KiB
Markdown
---
|
|
name: channels-routes
|
|
description: Handle 3 OpenAPI operation(s) under /v2/channels for the channels route group.
|
|
---
|
|
|
|
# channels API Routes
|
|
|
|
Handle 3 OpenAPI operation(s) under /v2/channels for the channels route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### list_channels
|
|
|
|
- Operation ID: `list_channels`
|
|
- Route: `GET /v2/channels`
|
|
- Mode: READ
|
|
- Summary: ListChannels
|
|
- Parameters:
|
|
- `reference_type` in `query`
|
|
- `reference_id` in `query`
|
|
- `status` in `query`
|
|
- `cursor` in `query`
|
|
- `limit` in `query`
|
|
|
|
### bulk_retrieve_channels
|
|
|
|
- Operation ID: `bulk_retrieve_channels`
|
|
- Route: `POST /v2/channels/bulk-retrieve`
|
|
- Mode: WRITE
|
|
- Summary: BulkRetrieveChannels
|
|
- Body: JSON request body accepted.
|
|
|
|
### retrieve_channel
|
|
|
|
- Operation ID: `retrieve_channel`
|
|
- Route: `GET /v2/channels/{channel_id}`
|
|
- Mode: READ
|
|
- Summary: RetrieveChannel
|
|
- Parameters:
|
|
- `channel_id` in `path` required
|