WebRTC Service - API Overview

Managing and interacting with the iotcomms.io WebRTC Service is seamless with a set of core REST APIs. These APIs allow you to provision devices, configure trunks, monitor logs, set up notifications, and access performance statistics, providing everything needed for smooth and efficient operations.

1. Device API

   The Device API is essential for managing your WebRTC application authentication. You can add, update, or remove applications to be connected within your domain, simplifying onboarding and configuration updates. Retrieve a complete list of applications registered under your domain to maintain an organized view of active WebRTC endpoints. Removing applications that are no longer in use is just as straightforward, keeping your system streamlined and up to date.

   • Main Endpoints

     • GET /device/{domain}: Retrieve all WebRTC applications using SIP credentials in your domain.

     • PUT /device/{domain}: Add or update a WebRTC application using SIP credentials in your domain.

     • DELETE /device/{domain}/{deviceId}: Remove a WebRTC application using SIP credentials from your domain.

2. Trunk API

   The SIP Core Service's trunk connectivity function enables your system to connect to external networks, such as the PSTN or other SIP services. The Trunk API allows you to configure and manage these trunks, providing flexibility and control over connections with external networks. Whether setting up new trunks, updating existing ones, or removing trunks no longer needed, the Trunk API supports seamless, reliable communication.

   • Main Endpoints

     • GET /trunk/{domain}: View details of all configured trunks in a domain.

     • POST /trunk/{domain}: Create a new trunk for WebRTC to external system communication.

     • PUT /trunk/{domain}/{trunkId}: Update an existing trunk.

     • DELETE /trunk/{domain}/{trunkId}: Remove a trunk from your configuration.

3. Logs API

   For troubleshooting and monitoring, the Logs API is indispensable. This API provides access to WebRTC and SIP signaling logs, helping you track registration attempts, call setups, and other signaling traffic. Whether diagnosing issues or monitoring real-time traffic, the Logs API delivers the detailed insights needed for effective management.

   • Main Endpoint

     • POST /logs/{domain}/sip: Retrieve signaling logs for a specific domain.

4. Notification Settings API

   The Notification Settings API keeps you informed about critical events, such as service alarms or warnings. Configure callback URLs to receive these notifications in real-time, enabling quick response and troubleshooting without constant dashboard monitoring.

   • Main Endpoints

     • GET /notificationsettings/{domain}: View current notification settings.

     • PUT /notificationsettings/{domain}: Update the notification settings for your domain.

5. Statistics API

   The Statistics API provides real-time insights into system performance, offering detailed statistics on application registrations, call traffic, and other metrics. Use this API to monitor service health, identify trends, and optimize operations with precise, actionable data.

   • Main Endpoints

     • GET /statistics: Retrieve general system statistics.

     • GET /statistics/{domain}/{type}/{bucketsize}: Retrieve specific statistics for a domain and service type.

Together, these APIs provide powerful tools for managing, monitoring, and optimizing the WebRTC Service. Whether provisioning applications, configuring trunks, analyzing logs, setting up notifications, or tracking performance metrics, these APIs offer the control and flexibility needed to maintain reliable, secure, and high-quality WebRTC communications.