PPL Information: SIP UA 0x00A7

Overview

The following contains information on PPL Event IDs used for the SIP User Agent (UA).

PPL Event Requests

 

Table 5-2 PPL Event Requests

PPL Event ID

Purpose

Description

AIB Used

SIP Registration Support (See details following this table.)

 

0x000A

Accept Registration Request

The host application uses this ID to accept the registration request.

0x7F - Stack ID

0x000B

Reject Registration Request

The host application uses this ID to reject the registration request.

0x7F - Stack ID

0x000C

Authenticate Request

NPDI formatted data for scheme, realm, username and password required to authenticate the incoming SIP call.

0x7F - Stack ID

 

 

0x0010

Query All Registration

Queries all registration entries in the CSP database.

0x7F - Stack ID

0x0011

Query Single Registration

Queries individual registration information from the CSP.

0x7F - Stack ID

0x0012

Delete All PPL Registrations

Deletes all end points registered with the CSP.

0x7F - Stack ID

0x0013

Delete Specific Registration

Deletes individual registration information from the CSP. The host application must provide the To Username parameter in the request that it sends.

 

0x7F - Stack ID

Call Control (See details following this table.)

 

0x000C

Authenticate Request

NPDI formatted data for scheme, realm, username and password required to authenticate the incoming SIP call.

0x0D - Channel

 

0x001E

Change Local Media Connection Attribute

Used to change the local media connection attribute.

0x0D - Channel

0x001F

Generate Early Media

Used by host application to generate early media by sending 183 response code with SDP for an incoming call.

0x0D - Channel

 

0x0020

Notify

Contains TLV 0x294B Notify Status which contains the SIP status to be sent to the UA, within a NOTIFY message.

0x0D - Channel

 

0x0021

Generates SIP ACK with SDP

Used in CAM delayed media scenario to send answer media parameters in ACK. This PPL ER must contain the TLV 0x2A00 Media Remote End Point Information.

0x0D - Channel

0x0023

Subsequent Data

Used by the host application to send data to the CSP that could not be sent in the Route Control message.

0x0D - Channel

 

0x0024

Generate RE-INVITE

Generates RE-INVITE message to the SIP endpoint connected to that channel

Works only if the call is in bearer-free mode.

0x0D - Channel

0x0025

Generate INFO

Generates INFO Message.

0x0D - Channel

0x0026

Generate 182

Generates 182 Queued message

0x0D - Channel

0x0027

Generate outbound REFER

Generates an outbound REFER request with the refer target URL filling in the TLV

0x0D - Channel

0x0029

Do Not Close Socket

Prevents automatic closing of a socket -typically a TCP socket.

0x0D - Channel

 

SIP Registration Support

A call handle is used for all SIP Registration PPL Event Requests. Events 0x000A 0x000B 0x000C use the Call Handle that was reported in the associated PPL Event Indication. All other registration events use a Call Handle of 0xFFFF

Example: Querying all Registrations:
00 12 00 44 00 00 ff 00 01 7f 04 ff 00 ff ff 00 a7 00 10 00

Call Control

Connection mode can be changed with TLV 0x27B3 NPDI RTP Connection Mode.

Change Local Media Connection Attribute

Example: Change the Connection to Listen Mode:
00 1d 00 44 00 02 ff 00 01 0d 03 00 01 04 00 a7 00 1e 01 03 00 33 00 07 00 01 27 b3 00 01 01

Generate Local Media

Example: Generate Early Media H->X:
00 11 00 44 00 00 ff 00 01 0d 03 00 01 02 00 a7 00 1f 00

Authenticate Request

The following TLVs are used with the PPL event ID 0x0C:

0x2937 NPDI SIP Authenticate Scheme

0x2938 NPDI SIP Authentication Realm

0x2939 NPDI SIP Authenticate Username

0x293A NPDI SIP Authenticate Password

0x293F NPDI SIP Authentication Timeout

The following TLVs are used with the Route Control message.

0x293B NPDI SIP Authorization Username

0x293C NPDI SIP Authorization Password

0x293D NPDI SIP Proxy Authorization Username

0x293E NPDI SIP Proxy Authorization Password

Call Socket

The remote_ip variable is the four-byte IP Address of the remote socket that was reported to the host application in the Request for Service message with the SIP Remote IP Address TLV.

The remote_port variable is the two-byte port number of the remote socket that was reported to the host application in the Request for Service message with the SIP Remote IP Port TLV.

00 27 00 44 00 00 FF 00 01 7f 04 ff 00 ff ff 00 a7 00 28 01 03 00 33 00 10 00 02 29 4E 00 04 0A 0A 29 4F 00 02 00 01

Don’t Close Socket

In response to a Request for Service message containing a SIP Transport Type TLV containing the following:

a value of 2 = TCP

the SIP Remote IP Address

SIP Remote IP Port TLVs

The host application may determine that the underlying socket needs to remain open to allow the reuse of this socket for multiple transactions. When that is the case, the host application immediately sends this PPL Event Request message to prevent the socket from closing.

Example:
00 11 00 44 00 00 FF 00 01 0d 03 00 00 01 00 a7 00 29 00

 

PPL Event Indications

 

Table 5-3 PPL Event Indications

PPL Event Indication ID

Purpose

Description

SIP Registration Support

0x000A

Incoming Registration Request

Informs the host application of an incoming REGISTER message.

0x000B

Registration Timer Expired

Informs the host application about an expired registration.

0x000C

Incoming De-registration Request

Informs the host application that a remote UA requested to delete a registration.

0x000D

Registration Query Response

Sends registration information to the host application as a response to a query message.

Call Control

0x001E

Media Change Detected

Sent to the host application whenever the remote side changes its media connection attributes with the
RE-INVITE message.

0x001F

183 Progress

Notifies the host application that the remote side sent a 183 Response Code.

If SDP data is in the response, the CSP sends the data to the host application in NPDI TLV format as follows:

0x2794 - Destination IP Address

0x2795 - Destination RTP Port

0x29FF - Media Local End Point Information - if Call Agent is enabled (must be less than 250 bytes).

0x0020

Answer on B-Side

Sent to the host application when the CSP receives a 200 OK response with a Session Description Protocol (SDP) for an outbound call.

This PPL Event Indication contains the TLV 0x29FF Media Local End Point Information (must be less than 250 bytes).

0x0021

Blind Refer PPL Event Indication

Notifies the host application that a Blind Refer event has occurred. The host application must respond by sending the PPL Event Request Notify with an appropriate SIP status. This PPL Event Indication will contain several TLVs as follows:

0x2916 SIP A Leg Transport Type

0x2919 NPDI SIP To User Name

0x291B NPDI SIP To Host Name

0x291C NPDI SIP to Port Name

0x291A NPDI SIP To Password (optional)

0x0022

Consultative Refer PPL Event Indication

Notifies the host application that a Consultative Refer Event has occurred. The host application must respond by sending the PPL Event Request Notify with an appropriate SIP status.

The PPL Event Indication contains the following TLVs:

0x2919 NPDI SIP To User Name

0x291B NPDI SIP To Host Name

0x291C NPDI SIP to Port Name

0x294C Refer Spans Channel

0x291A NPDI SIP To Password (optional)

0x0023

Subsequent Data

Notifies the host application that the CSP is sending more data that could not be sent in the Request for Service with Data message.

0x0024

180 Ringing

Notifies the host application that the remote side sent a 180 Response Code.

If SDP data is in the response, the CSP sends the data to the host application in NPDI TLV format as follows:

0x2794 - Destination IP Address

0x2795 - Destination RTP Port

0x29FF - Media Local End Point Information - if Call Agent is enabled (must be less than 250 bytes).

0x0025

Send subsequent data

Notifies the host application that the SIP UA is ready to accept more data from the host application.

0x0026

All subsequent data received

Notifies the host application that the SIP UA received the last message in the sequel.

 

0x0027

Result of the sent REFER request

Reports a REFER response was received and the Response Code received.

The value in the SIP Response Code TLV (0x2915) reports the exact response code

Success - 2xx

Failure - 4xx-6xx

0x0028

Status of the Reference

Reports a NOTIFY request was received and the response code from the NOTIFY body.

The value in the SIP Response Code TLV (0x2915) reports the exact response code.

0x0029

Reported to the host when the CSP receives an ACK.

Contains the SDP received in the SIP ACK message in 0x29FF TLV (Media Local End Point Information)

0x0031

422 Session Timer Too Small

Reports the Session Expiry Interval and Minimum Session Expiry interval used in the Re-transmit INVITE message.

The values in the following TLVs report this information:

SIP Session Expiry Interval (0x2969)

SIP Minimum Session Expiry Interval (0x2970)

0x002C

INFO Received

Report receipt of INFO message.

0x002D

Response for INFO

Report the response received for the INFO message sent.

0x002E

182 Received

Report receipt of 182 Queued message.