Cloud SIP UA Service - Getting Started

Download OpenAPI specification:Download

Getting Started

At Your Side:

  1. Generate API Keys

    Begin by generating the API keys necessary to authenticate API calls with the iotcomms.io Cloud SIP UA Service. These keys ensure secure access and enable proper interaction with the service.
  2. Firewall Configuration

    Configure your firewall to allow HTTPS callbacks from the Cloud SIP UA Service. Specify callback URLs during provisioning and ensure they are accessible to maintain uninterrupted communication. Additionally, open your firewall for RTP media traffic to and from the devices. Ensure that the IP addresses and ports used for RTP streams are permitted, as this is essential for media delivery.
  3. Prepare Your Application

    Set up your application to use the REST APIs for SIP signaling interworking. Ensure your application is configured to handle incoming HTTPS callbacks for events such as incoming calls, call progress updates, and media routing instructions.
  4. Configure RTP Media Handling

    Plan and set up the IP addresses, ports, and codecs for media streams to ensure seamless RTP communication. The Cloud SIP UA Service will use this information to negotiate media paths dynamically with remote endpoints.

Provisioning the Service:

  1. Set Up Devices

    Use the iotcomms.io web interface or provisioning API to configure devices authorized to use the Cloud SIP UA Service. This includes associating devices with their respective credentials and settings.
  2. Configure Callback Destinations

    Set up callback URLs for receiving event notifications from the Cloud SIP UA Service. These callbacks notify your application of SIP events such as new calls, call terminations, and DTMF inputs.
  3. Assign RTP Media Parameters

    Define the IP addresses, ports, and codec preferences for each device during provisioning. This step ensures that media routing is configured correctly and ready for active sessions.
  4. Set Up SIP Core Trunk Connectivity, Alarmbridge Service or SIP Mediaserver Service Integration

    Configure SIP Core trunk connectivity to enable calls to external systems, such as PSTN or other SIP endpoints, for seamless outbound and inbound call handling. Alternatively, integrate the Alarmbridge Service or SIP Mediaserver Service to develop advanced interactive call applications, including IVR systems, media playback, and real-time media processing. This setup allows lightweight devices to participate in sophisticated communication scenarios.

Testing the Service:

  1. Place a Test Call

    Invoke the /placeremotecall REST API endpoint to trigger the Cloud SIP UA Service to send a SIP INVITE to the desired remote SIP endpoint. Verify that the call progresses correctly, and callbacks for call status updates are received by your application.
  2. Verify RTP Media Flow

    Confirm that RTP streams are being routed as specified. Ensure the negotiated IP addresses, ports, and codecs align with the media configuration for seamless communication.
  3. Review Logs in the Developer Portal

    Use the Logs view in the Developer Portal to verify the sequence of events. Confirm that the /placeremotecall REST API call and the corresponding SIP INVITE request are logged and routed correctly. This step ensures that signaling and API interaction are functioning as expected.

This setup ensures your Cloud SIP UA Service is fully configured, operational, and ready to manage real-time communication for lightweight devices reliably.