Switch icon

Switch

Switch API Integration
Join our community

Actions9

Overview

This node integrates with the Switch API to manage communication communities by performing various operations such as listing groups, channels, sending messages, creating groups or channels, forwarding and pinning messages, and sending media. It is useful for automating community management tasks and messaging workflows within a communication platform.

For the List Groups operation specifically, the node retrieves all groups associated with a specified community ID. This can be beneficial when you want to dynamically fetch and process group information from a community, for example, to display available groups, synchronize group data, or trigger actions based on group membership.

Properties

Name Meaning
Community ID ID of the community to list groups from (required)

Output

The output is an array where each item contains a json object representing the response from the Switch API's list_groups endpoint. This JSON typically includes details about the groups in the specified community, such as group IDs, names, descriptions, privacy status, and other metadata provided by the API.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the Switch API.
  • The node makes HTTP POST requests to a local server at http://localhost:8000/list_groups.
  • The API token is sent in the Authorization header as a Bearer token.
  • Ensure that the Switch API service is accessible at the configured URL and that the API token is valid.

Troubleshooting

  • Common issues:
    • Invalid or missing community ID will cause the API request to fail.
    • Incorrect or expired API token will result in authorization errors.
    • Network connectivity issues to http://localhost:8000 will prevent the node from reaching the API.
  • Error messages:
    • "Operation "listGroups" not supported": This indicates an internal misconfiguration; ensure the operation name is correctly set.
    • API error responses will be returned in the output JSON under an error field if "Continue On Fail" is enabled.
  • Resolutions:
    • Verify the community ID input is correct and exists.
    • Check and update the API authentication token.
    • Confirm the Switch API service is running and reachable at the expected URL.

Links and References

Discussion