Developer Guide for SIP Transparency and Normalization
Preface
Downloads: This chapterpdf (PDF - 354.0KB) The complete bookPDF (PDF - 1.86MB) | Feedback

Preface

Table Of Contents

Preface

Audience

Organization

Conventions

Obtaining Documentation and Submitting a Service Request

Developer Support


Preface


This document describes the customization process of the SIP messages on Cisco Unified CM- Session Manager Edition (CUCM-SME). It also describes the details on Lua environment available on CUCM-SME and APIs to support SIP Transparency and Normalization functionality

The preface covers these topics:

Audience

Organization

Conventions

Obtaining Documentation and Submitting a Service Request

Developer Support

Audience

This document provides information for developers, vendors, and customers who are developing applications or products that integrate with Cisco Unified Communications Manager 8.5(1)) using SIP Transparency and Normailzation.

Organization

This document includes the following sections.

Chapter
Description

Chapter 1, "Overview"

Provides an overview of Lua Environment, the interface used for customizing Session Management (SM) behavior for a particular deployment.

Chapter 2, "SIP and SDP Normalization"

Provides introduction to the Lua scripting environment APIs used for manipulating the SIP message and any associated Session Description Protocol (SDP).

Chapter 3, "SIP Messages APIs"

Explains the Lua scripting environments SIP Message APIs that allows messages to be manipulated.

Chapter 4, "SDP APIs"

Explains the APIs associated with Session Description Protocol (SDP) content bodies.

Chapter 5, "SIP Pass Through APIs"

Explains the pass through object provided APIs that allows information to be passed from one call leg to the other.

Chapter 6, "SIP Utility APIs"

Explains the APIs that allows data strings to be manipulated

Chapter 7, "SIP URI APIs"

Explains the APIs that allows a parsed SIP URI to be manipulated.

Chapter 8, "Trace APIs"

Explains the how tracing allows the script writer to produce traces from within the script. This must only be used for debugging the script.

Chapter 9, "Script Parameters API"

Explains how the Script parameters allows the script writer to obtain trunk specific configuration parameter values.

Chapter 10, "SIP Transparency"

Provides introduction to the Lua scripting environment APIs used for SIP Transparency.


Conventions

This document uses the following conventions:

Convention
Description

boldface font

Commands and keywords are in boldface.

italic font

Arguments for which you supply values are in italics.

[ ]

Elements in square brackets are optional.

{ x | y | z }

Alternative keywords are grouped in braces and separated by vertical bars.

[ x | y | z ]

Optional alternative keywords are grouped in brackets and separated by vertical bars.

string

A nonquoted set of characters. Do not use quotation marks around the string or the string will include the quotation marks.

screen font

Terminal sessions and information the system displays are in screen font.

boldface screen font

Information you must enter is in boldface screen font.

italic screen font

Arguments for which you supply values are in italic screen font.

Æ

This pointer highlights an important line of text in an example.

^

The symbol ^ represents the key labeled Control—for example, the key combination ^D in a screen display means hold down the Control key while you press the D key.

< >

Nonprinting characters, such as passwords are in angle brackets.


Notes use the following conventions:


Note Means reader take note. Notes contain helpful suggestions or references to material not covered in the publication.



Caution Means reader be careful. In this situation, you might do something that could result in equipment damage or loss of data.


Tip Means the following information might help you solve a problem.


Obtaining Documentation and Submitting a Service Request

For information on obtaining documentation, submitting a service request, and gathering additional information, see the monthly What's New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation, at:

http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html

Subscribe to the What's New in Cisco Product Documentation as a Really Simple Syndication (RSS) feed and set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free service and Cisco currently supports RSS Version 2.0.

Developer Support

The Developer Support Program provides formalized support for Cisco Systems interfaces to enable developers, customers, and partners in the Cisco Service Provider solutions Ecosystem and Cisco Partner programs to accelerate their delivery of compatible solutions.

The Developer Support Engineers, an extension of the product technology engineering teams, have direct access to the resources that are necessary to provide expert support in a timely manner.

For additional information on this program, refer to the Developer Support Program Web Site at www.cisco.com/go/developer support/.

Developers who use the SIP Line Messaging Guide are encouraged to join the Cisco Developer Support Program. This new program provides a consistent level of support while leveraging Cisco interfaces in development projects.

Cisco Technical Assistance Center (TAC) support does not include SIP Developer support and is limited to Cisco installation/configuration and Cisco-developed applications. For more information about the Cisco Developer Support Program, contact Cisco at developer-support@cisco.com.