SIP Core Service - API Overview

Managing and interacting with iotcomms.io SIP Core Services is seamless with a set of core REST APIs. These APIs allow you to provision devices, set up trunks, monitor logs, configure notifications, and access system statistics, giving you everything you need to ensure smooth and efficient operations.

The Device API is essential for managing your SIP devices. You can add, update, or remove devices within your domain. If you're onboarding new devices or updating configurations, this API simplifies the process. You can also retrieve a complete list of devices registered under your domain, helping you keep track of active endpoints. When a device is no longer needed, removing it is just as easy. This API is perfect for maintaining a clear view and control over your device ecosystem.

• Main Endpoints

  • GET /device/{domain}: Retrieve all devices in a specific domain.

  • PUT /device/{domain}: Add or update a device in your domain.

  • DELETE /device/{domain}/{deviceId}: Remove a device from your domain .

SIP trunks allow your system to make and receive calls from external networks, such as the PSTN or other SIP services. The Trunk API lets you configure and manage these trunks. Whether you're setting up new trunks to expand your communication capabilities, updating existing ones, or removing trunks that are no longer needed, this API gives you flexibility and control. It's an efficient way to manage how your SIP system interacts with external networks, ensuring seamless communication.

• Main Endpoints

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

  • POST /trunk/{domain}: Create a new SIP trunk.

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

  • DELETE /trunk/{domain}/{trunkId}: Remove a SIP trunk .

TODO: Verify this is in the other service API description

For troubleshooting and monitoring, the Logs API is indispensable. This API provides access to SIP signaling logs, helping you track registration attempts, call setups, and other SIP traffic. It's a powerful tool when diagnosing issues or verifying that everything is working as expected. Whether you need to dig into specific events or just monitor real-time traffic, the Logs API gives you the detailed insights needed for effective management.

• Main Endpoint

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

The Notification Settings API ensures you're always informed about critical events, such as service alarms or warnings. With this API, you can configure where and how to receive these notifications by setting up callback URLs. This way, you can get immediate alerts when issues arise, allowing for quick resolution without needing to manually check system dashboards.

• Main Endpoints

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

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

The Statistics API provides real-time insights into your system's performance. You can access detailed statistics on device registrations, call traffic, and other key metrics. This API helps you monitor the health of your services and spot any trends or issues. Whether you need a high-level overview or detailed data for specific services, the Statistics API delivers the metrics you need to optimize your operations.

• 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 offer robust tools for managing, monitoring, and optimizing your iotcomms.io SIP Core Services. Whether you're provisioning devices, configuring trunks, analyzing logs, setting up notifications, or checking performance metrics, these APIs provide the control and flexibility you need to maintain reliable and secure communications.