Poli icon

Poli

Node principal para interagir com a API da Poli

Channel → Get Channel

AI-generated

Overview

This node operation retrieves detailed information about a specific channel associated with an account using the channel's UUID. It is useful in scenarios where you need to fetch configuration or status details of a particular communication channel within an account, such as for monitoring or integration purposes.

Use Case Examples

  1. Fetching channel details by providing the Account Channel UUID to get its configuration and status.
  2. Including additional fields like 'config' in the response to get extended channel information.

Properties

Name Meaning
Account Channel UUID The unique identifier (UUID) of the channel within the account, required to specify which channel to retrieve.
Options Additional options to customize the response, such as including extra fields.

Output

JSON

  • channel
    • id - The unique identifier of the channel.
    • name - The name of the channel.
    • type - The type of the channel.
    • config - Configuration details of the channel, included if requested.

Dependencies

  • Requires an API key credential to authenticate with the Poli API.

Troubleshooting

  • Ensure the Account Channel UUID is correctly provided and valid; otherwise, the API call will fail.
  • If additional fields are requested via the 'include' option, verify that the requested fields are supported by the API.
  • Common errors include resource or operation not found if parameters are incorrect; verify the resource is 'channel' and operation is 'get'.
  • Network or authentication errors may occur if the API key credential is missing or invalid.

Discussion