Vocalhost

Vocalhost is a communication solution that enables direct and reliable connections between systems using WebSocket protocol. It comprises a bridge server and a client agent, offering support for a wide range of languages, frameworks, and systems. This versatility allows for seamless interaction and efficient data exchange across diverse environments.

The bridge server acts as a central hub, relaying real-time messages between connected systems over WebSocket connections. The client agent establishes a WebSocket connection with the bridge server, facilitating communication across various platforms.

Vocalhost simplifies system-to-system interaction, providing compatibility and ease of use across different languages, frameworks, and systems. This promotes streamlined data exchange.

Getting Started

Vocalhost is a communication solution that enables direct and reliable connections between systems using the WebSocket protocol. It consists of a bridge server and two client agents: VocalhostReceiver and VocalhostRequest.

  1. Install the Vocalhost library:
pip install vocalhost

VocalhostReceiver

The VocalhostReceiver client establishes a WebSocket connection with the bridge server and keeps the connection open to receive incoming messages. It processes the received messages and generates a response.

Usage

  1. Import the necessary modules:
import vocalhost
  1. Pass your Vocalhost API key:
vocalhost.API_KEY = API_KEY
  1. Define a function to process the received messages and generate a response:
def process_message(message):
    # Process the received message and generate a response
    # Implement your custom logic here
    print("Received message from VocalhostRequest:", message)

    # Generate the response
    response = "This is the response from the VocalhostReceiver"
    return response
  1. Assign process_message function: 
vocalhost.process_message = process_message
  1. Connect to the Vocalhost server:
client_id = 'RECEIVER_ID_0R_NAME'
vocalhost.Receiver.connect(client_id=client_id)

The VocalhostReceiver client will establish a WebSocket connection with the bridge server and start listening for incoming messages. When a message is received, the process_message function will be invoked to process the message and generate a response.

VocalhostRequest

The VocalhostRequest client is used to send HTTP POST requests to the Vocalhost bridge server, which will forward the requests to the VocalhostReceiver client. The VocalhostReceiver client will process the request, generate a response, and send it back to the bridge server. The bridge server will then respond to the VocalhostRequest client with the received response.

Usage

  1. Import the necessary modules:
from vocalhost import Request
  1. Pass your Vocalhost API key:
vocalhost.API_KEY = API_KEY
  1. Send data:
message = 'How about a game of chess?'
response = vocalhost.Request.send(message, receiver_id=receiver_id)
  1. Process the response received from the Receiver:
print(response.text)

The VocalhostRequest client sends an HTTP POST request to the Vocalhost bridge server, specifying the URL of the VocalhostReceiver client to connect to. The bridge server will forward the request to the VocalhostReceiver client, which will process the request and generate a response. The response will be sent back to the bridge server, and the bridge server will respond to the VocalhostRequest client with the received response.

Please note that you need to replace the example URLs and headers with the actual values according to your setup.

With Vocalhost, you can streamline system communication by establishing WebSocket connections between systems, enabling real-time message exchange and seamless interaction across different languages, frameworks, and systems.

API

This section is only available to logged-in users. Please log in to access the API.

Changelog

See what's new added, changed, fixed, improved or updated in the latest versions.

For Future Updates Checkout Github

Version 1.2

  • Updated Updated python client
  • Updated Updated receiver connection
  • Updated Security

Version 1.1

  • Added Clients Connected, available, busy
  • Fixed Fixed websocket connection timeout
  • Fixed Fixed client response timeout
  • Updated Websocket connection
  • Updated Receiver

Version 1.0

Initial Release