You are here: CSP Developer’s Guide: Internet Protocol > 5 Session-Initiation Protocol (SIP) Software > Host Controlled SIP Registration Failure Response Code

Host Controlled SIP Registration Failure Response Code

Overview

This feature allows host application developers to control the SIP response code when the CSP rejects incoming registration requests.

Prior to the release of this feature, the SIP stack sent the hard-coded 503 response code when rejecting an incoming registration.

Description

The host application developer provides a final response code that the SIP stack will send to reject a SIP REGISTER message. The PPL Event request type Reject Registration contains the SIP Response Code TLV (0x2915).

The response can be code types 4xx, 5xx, or 6xx. Refer to the Responses section.

This feature is meant to reject and not authenticate registration requests.

In order to authenticate a registration request, send a 401/407 response code in the PPL Event Request message (Authenticate Request).

Configuring

If you want to reject a registration with a 423 response (Interval Too Brief) use the VoIP Protocol Configure (0x00EE) message with the Minimum Registration Duration (0x0283) TLV. Refer to Host Control Method of SIP 180 Provisional Response Generation.

For all other rejections use the PPL Event Request message with SIP Response Code TLV (0x2915).

Example:

Below is the PPL event indication sent to the host application when a REGISTER is received. The following PPL event request is the rejection (cause code 403 which is value 0x0193 in SIP Response Code TLV (0x2915).

Following the API is the SIP messaging.

API Message

X->H

[00 8e 00 43 00 00 00 00 01 7f 04 ff 00 2d 09 00 a7 00 0a 01

03 00 33 00 77 00 0b 29 19 00 05 38 35 36 36 00 29 1b

00 0e 31 39 32 2e 31 36 38 2e 31 2e 31 30 31 00 29 1c

00 04 00 00 13 c4 29 23 00 05 38 35 36 36 00 29 25 00

0e 31 39 32 2e 31 36 38 2e 31 2e 31 30 31 00 29 26 00

04 00 00 13 c4 29 2d 00 05 38 35 36 36 00 29 2f 00 0d

31 39 32 2e 31 36 38 2e 31 2e 35 30 00 29 30 00 04 00

00 13 c4 29 33 00 01 01 29 31 00 04 00 00 0e 10]

H->X

[00 05 00 43 00 00 00]

H->X

[00 05 00 43 00 00 00]

H->X

[00 1f 00 44 00 00 ff 00 01 7f 04 ff 00 2d 09 00 a7 00

0b 01 03 00 33 00 08 00 01 29 15 00 02 01 93]

X->H

[00 07 00 44 00 00 00 00 10]

2

SIP Messaging

1 -RECEIVED From 192.168.1.50:1071 at 915

REGISTER sip:192.168.1.101 SIP/2.0

From: sip:8566@192.168.1.101;tag=6551c6551

To: sip:8566@192.168.1.101

Call-Id: e8b903dc85bc74c9af9a27e10dbd1030

Cseq: 113 REGISTER

Contact: <sip:8566@192.168.1.50;LINEID=c97ec9224a2f2cf6c623826820822791>

Expires: 3600

Date: Mon, 26 Jul 2004 12:36:12 GMT

Accept-Language: en

Supported: sip-cc, sip-cc-01, timer, replaces

User-Agent: Pingtel/2.1.11 (VxWorks)

Content-Length: 0

Via: SIP/2.0/UDP 192.168.1.50

2 -SENT To 192.168.1.50:5060 at 915

SIP/2.0 100 Trying

To: sip:8566@192.168.1.101;tag=9150

From: sip:8566@192.168.1.101;tag=6551c6551

Call-ID: e8b903dc85bc74c9af9a27e10dbd1030

CSeq: 113 REGISTER

Via: SIP/2.0/UDP 192.168.1.50

User-Agent: Excel_CSP/82.30.112

Content-Length: 0

3 -SENT To 192.168.1.50:5060 at 915

SIP/2.0 403 Forbidden

To: sip:8566@192.168.1.101;tag=9150

From: sip:8566@192.168.1.101;tag=6551c6551

Call-ID: e8b903dc85bc74c9af9a27e10dbd1030

CSeq: 113 REGISTER

Via: SIP/2.0/UDP 192.168.1.50

User-Agent: Excel_CSP/82.30.112

Content-Length: 0

Session-Initiation Protocol. A signaling protocol used for establishing sessions in an IP network. A session could be a simple, two-way telephone call, or it could be a collaborative multi-media conference session.
See Programmable Protocol Language.
Tag-Length-Value block. A standardized block that allows data to inserted in a standard way into API messages.
A condition that, when met, drives a state machine from one state to another. A condition that drives a Component out of its current state by invoking an associated primitive.
Voice over Internet Protocol. The delivery of voice information in digital form in discrete packets rather than in the traditional circuit-committed protocols of the public-switched telephone network (PSTN).
In PPL, a condition that, when met, drives a state machine (PPL Component) from one state to another, by invoking an associated Primitive. In PPL files, an Event is marked by an arrow and text.