Websocket

Overview

WebSocket, a powerful feature within VoIPBin, revolutionizes web applications by enabling them to subscribe to specific event topics. This capability facilitates real-time updates, ensuring dynamic data changes are seamlessly communicated during runtime.

WebSocket establishes a persistent and bi-directional connection with the VoIPBin server, providing web applications with real-time capabilities for constructing dynamic and interactive communication applications.

Websocket endpoint

To leverage WebSocket in VoIPBin, connect to the following endpoint:

GET wss://api.voipbin.net/v1.0/ws?token=<your authtoken here>

Topic Subscription/Unsubscription

WebSocket functionality empowers users to finely tune their event subscriptions in the VoIPBin system, tailoring updates to match their application’s specific resource needs. This section outlines the process for subscribing or unsubscribing from event topics.

To initiate a subscription or unsubscription, send the following JSON message through the established WebSocket:

{
    "type": "<subscribe|unsubscribe>",
    "topics": ["<topic>", ...]
}

The topic format is as follows:

agent_id:<agent_id>:<resource>:<resource-id>
customer_id:<customer_id>:<resource>:<resource-id>

Here’s an example of a subscribe message:

{
    "type": "subscribe",
    "topics": [
        "customer_id:5013bc52-da9a-11ee-844f-2fa34248de28:activeflow:74ac5405-7c70-4184-9388-1c9f8f8ce25f"
    ]
}

Subscribing to the topic activeflow:74ac5405-7c70-4184-9388-1c9f8f8ce25f ensures reception of events related to the specified activeflow resource with the provided ID.

It is crucial to adhere to the correct topic structure, including the following prefixes:

• agent_id:<agent-id>

• customer_id:<customer-id>

Additionally, specific permissions are required for different levels of topics:

Customer Level Topics

To subscribe to topics at the customer level, the following permissions are required:

• Admin permission

• Manager permission

Agent Level Topics

For agent-level topics, only the owner of the agent can subscribe to the topic.

Ensure the accuracy of your topic definition to successfully subscribe to the desired events.

Pattern Matching Subscription

WebSocket supports pattern matching subscriptions, allowing users to subscribe to multiple topics based on a pattern. For example, subscribing to the <resource> topic encompasses all events related to a specific resource type.

This pattern matching approach streamlines and enhances topic subscriptions, enabling users to receive updates for multiple resources without the need for individual subscriptions.

Real-Time Event Updates

When an event transpires for a subscribed topic, VoIPBin dispatches the corresponding event data to the WebSocket connection. Web applications receive this data in real-time, facilitating immediate updates and dynamic data changes within the application.

Web applications can seamlessly process these event updates to trigger actions, update UI elements, or reflect changes in the user interface without resorting to manual page refreshes. WebSocket ensures a seamless and interactive user experience, keeping users consistently informed with the latest information.

Benefits of WebSocket

WebSocket extends various benefits to web applications leveraging VoIPBin:

• Real-Time Communication: WebSocket fosters instant updates and event notifications, establishing real-time communication between the web application and the VoIPBin server.

• Dynamic Data Updates: WebSocket facilitates the handling of dynamic data changes, enabling the creation of dynamic and interactive user interfaces.

• Efficient Subscription: Pattern matching subscription efficiency allows users to subscribe to multiple resources without the need for individual subscriptions.

• Reduced Latency: By eliminating the need for repeated HTTP requests, WebSocket reduces latency, enhancing the overall responsiveness of the application.

Struct

Subscribe

{
    "type": "unsubscribe",
    "topics": [...]
}

• topic: List of subscribe topics.

Example

{
    "type": "subscribe",
    "topics": ["call"]
}

Unsubscribe

{
    "type": "unsubscribe",
    "topics": [...]
}

• topic: List of unsubscribe topics.

Example

{
    "type": "subscribe",
    "topics": ["call"]
}