SIP INFO METHOD - Subscribe/Notify

Owned by Kelli Higdon
Last updated: Apr 02, 2024
4 min read

 

 

The IMG 2020 accepts User Agent Subscription Requests (SIP SUBSCRIBE method) and the ability to respond to those user agents with the appropriate DTMF digit events via the SIP NOTIFY method. RFC: 3265 Session Initiation Protocol (SIP)-Specific Event Notification.

The SIP INFO Method - "Subscribe Notify" allows a customer to develop user-specific applications that reside on a network entity and have the ability to subscribe for event services supported by the IMG 2020. If a network gateway wants to detect an entered DTMF digit (only telephone event of “###” are currently supported) from the TDM-side of a call to the IP side of a call, the gateway can subscribe to the IMG 2020 for these events and receive SIP NOTIFY events containing the digit event.

Supported Patterns

(####,###,##,#)

(####,###,##,#) -or- (**,**,*,*)

(####,###,##,#)

(####,###,##,#) -or- (**,**,*,*)

(####,###,##,#) -or- (**,**,*,*)


Call Flows

Per-Call Successful Subscribe/Notify

Per Gateway Successful Subscribe/Notify Call Flow

Per-Call Successful Subscribe Notify REFRESH

Call Tracing

Each SIP request received or transmitted for the SIP SUBSCRIBE and NOTIFY methods will be displayed in normal call tracing.  For the NOTIFY method, the trace will also display the NOTIFY methods payload. In the case of detected DTMF digits, the characters will be displayed in call tracing. To view a Call trace, refer to the call trace SIP INFO METHOD - Subscribe/Notify topic.

Configuration

Initial Configuration

The procedure below explains how to configure SIP Privacy on the IMG 2020. Before configuring, the IMG 2020 must have an initial configuration created on it. Follow the Basic Configurations procedure before proceeding.

Create SIP Signaling Gateway Profile (SGP)

Create a SIP Profile and then the SIP DTMF Support object.

  • Right click on the Dialogic object and select New Profiles. The Profiles object is a parent or container object and no configuration is needed here.

  • Right Click on the Profiles object and select New SIP Profiles. The SIP Profiles object is a parent or container object also and no configuration is required here. Refer to the SIP Profiles topic for more information on this object.

  • Right click on the SIP Profiles object and select New SIP Profile. The first profile that gets created is a Default SIP Profile and cannot be modified. Disregard this profile.

  • Right click on the SIP Profiles object just created again and select New SIP Profile. Either enter a Name into the name field that identifies this profile or accept the default entry. In this procedure the Name entered was INFO_Method_Sub_Not_Profile.

  • Right click on the SIP Profile object just created and select SIP DTMF Support. In the Method field, select Subscribe from drop down menu. Refer to the SIP Profile - DTMF Support topic for more information on configuring the remaining individual fields within this object.

Create a SIP Remote Gateway

Create a Remote Gateway that will be communicating with the Outgoing Channel Group. The gateway being configured will need the SIP Profile with the DTMF Support functionality configured in it. To link the SIP profile created with a Remote Gateway, an external network element must also be created. The next few sections describe how to configure this.

  • Right click on the Dialogic object and select New External Network Elements. The External Network Elements object is a container object and no configuration is needed in this object. Refer to External Network Elements for more information.

  • Right click on External Network Elements object and select New External Gateways. The External Gateways object is also a container object. Under the External Gateways object, multiple individual gateways can be created. Refer to External Gateways topic for more information.

  • Right click on External Gateways and select New External Gateway. In the name field either enter a name that identifies the gateway being configured or accept the default name. In this procedure, INFO_Method_Sub_Not_GW. Refer to the screen capture and table below.

Individual Fields Descriptions

  • Select SIP from drop down menu in the Protocol field.

  • Enter an IP address for this gateway

  • Select the SIP Profile (SGP) created earlier from drop down menu in the SIP Profile field.

Refer to the External Gateway topic for more information on configuring the External Gateway object. 

Configure SIP Signaling

The configuration above displays how to configure the SIP Profile and External SIP Gateway so that the SIP INFO Method - Subscribe/Notify functionality is configured. The next step is to configure the SIP signaling stack and SIP Channel Groups. Refer to the Configure SIP (Single SIP IP) topic for a procedure on how to configure the SIP functionality.

Additional Information

  • Patterns of 1-4 pound and wildcard (#)(*) characters are supported 

  • The Pending state is not supported

  • The IMG 2020 cannot send a SIP SUBSCRIBE

Return to Documentation Home I Return to Sangoma Support