Setting up SIP Intercom Integration

 

Introduction

This guide provides a step-by-step process for setting up and configuring an external intercom integration via SIP (Session Initiation Protocol). This setup is intended to help integrate remote commentary via Spalk into existing workflows using an on-site intercom system.

Overview and Workflow Diagram

Integrated intercom is crucial for maintaining a fast, clear communication between team members working in different places, which can be the difference between a successful and unsuccessful broadcast. Extending your existing intercom to Spalk via SIP is an easy way to ensure that commentators aren't "out of the loop" and can work easily with the existing team wherever they happen to be. The SIP integration is intended to be used with an intercom system that facilitates input and output audio via SIP. A typical workflow is:

SIP Configuration for an Organization

The first step to integrating your SIP system is to setup an organization SIP domain and configure your SIP Lines. The domain represents an endpoint that allows you to REGISTER and configure your SIP lines. A SIP Line is roughly equivalent to a device. It is a set of credentials that can be used to register with your device, and can be assigned to a single commentary team at a time. When the line is active it will facilitate two-way communication between the SIP line and the communication in the studio.

Creating a SIP Domain

1. Access SIP Config:
   • Navigate to SIP Config under your Organization settings. If you cannot see the SIP Config option, please contact your Spalk representative to enable it for your account.
2. Create a SIP Domain:
   • Click the plus button to create a new SIP Domain.
   • Select the region for the SIP Domain from the dropdown.
   • Decide on security settings based on the compatibility with your design's infrastructure.

Adding a SIP Line

1. Add Device Information:
   • Name the device (e.g., Intercom Server 01 High Street).
   • Set a username and password for the device.
   • Click plus button to create the Device.
2. Configure Username and Password on the Device:
   • Enter the details provided below:
     • SIP Registrar: (sip:SIP_DOMAIN:5060)
     • SIP Identity: (sip:USERNAME@SIP_DOMAIN)
     • Password: PASSWORD
   • Save, and attempt to register. The registration step should succeed on the device end.
3. Test Connection:
   • Dial sip:test@SIP_DOMAIN. You should hear the message "You have successfully connected to Spalk"
   • IMPORTANT: Please set your SIP device to dial "intercom@SIP_DOMAIN" for live productions.

Using SIP Lines in live productions

Assigning Lines to Teams

1. Access Dashboard:
   • Navigate to your event dashboard.
   • Find the event you wish to connect to via SIP
   • Navigate to the "Invite" tab
2. Attach SIP Lines:
   
   • Click on the SIP Lines box and find the SIP Line you wish to connect to the commentators.
   • Click the device to add it to the event.
   • Drag the SIP line to the correct team.
   • Click Update to attach the device to the commentary team.

Dialing from SIP Device

1. Dial into the Studio:
   • Dial the special address "intercom" within the SIP domain to connect to the studio.
   • Ensure the address format is correct (e.g., sip:intercom@SIP_DOMAIN).
2. Verify Connection:
   • Confirm the connection by checking the commentary studio. You should be able to hear each other, and be visible as a "Producer" in the commentator's video chat.

Limitations

Currently the SIP integration supports inbound calls to Spalk from devices registered under your Spalk allocated SIP domain. We do not currently support making outbound calls to your infrastructure, nor registering with external SIP registries.

Conclusion

This guide has walked you through the process of configuring SIP for your organization, adding and managing SIP lines, and using them in live productions. By following these steps, you can ensure seamless integration of remote commentary via Spalk into your existing workflows.