How to Configure SIP Monitoring Callbacks

Objective

Configuring the SIP call monitoring to receive real-time callback events for your SIP call on your app server.

Applies To

• Vonage Video API
• Projects
• SIP Call Monitoring

Contents 

• Procedure for Vonage Video API Opentok Environment
• Procedure for Vonage Video API Unified Environment
• Additional Information

How to recognise if I'm using Vonage Video API Unified Environment or Vonage Video API OpenTok environment?

Procedure for Vonage Video API Opentok Environment

SIP monitoring callback URL can be configured within the account portal. Whenever a SIP call event is detected, that is, a SIP call is created, updated, or destroyed, a HTTP POST request with the information about the progress of the SIP call is issued from the Vonage Video API infrastructure to your registered callback URL.

Callback URL can be configured by the registered Admin or Developer of your Vonage Video API account.

To register a callback:

1. Log in to your Vonage Video API Account.
2. From the left menu, choose the desired Account.
3. Select a Project for which you want to register a SIP monitoring callback.
4. Scroll down to Project Settings.
5. Under SIP Call Monitoring, click Configure.
6. Configure the callback URL and click Submit.
   
7. If the callback is successfully registered, a popup with "Callback URL Configured" will appear.
   
8. If the registered callback URL cannot be reached, a popup with "Configuration Failed" will appear. Double-check your callback URL and the server hosting the URL and Retry.
   

To remove the registered callback:

1. Under SIP Call Monitoring, click Remove.
   
2. Click Confirm Removal to remove the configured SIP monitoring callback.
   

Procedure for Vonage Video API Unified Environment

SIP monitoring callback URL can be configured within the account portal. Whenever a SIP call event is detected, that is, a SIP call is created, updated, or destroyed, a HTTP POST request with the information about the progress of the SIP call is issued from the Vonage Video API infrastructure to your registered callback URL.

Callback URL can be configured by the registered Admin or Developer of your Vonage Video API account.

To register a callback:

1. Log in to your Vonage Video API Unified Environment Account.
2. From the left menu, go to Applications.
3. Select your Video Application for which you want to register a SIP monitoring callback. Click Edit. 
4. Scroll down to Video. Click on Show advanced features. 
   
5. Under SIP call monitoring, add the callback URL.
6. Then, click Save changes on the lower right of the page.
   
7. To remove the registered callback, simply delete the URL from the HTTP POST of SIP call monitoring. 

Additional Information

For additional information about monitoring SIP call progress, see our developer documentation in Opentok Environment on SIP call monitoring or our developer documentation in Unified Environment for SIP Interconnect registering callbacks.