Dialogic 05-2239-009 User Manual

Dialogic® Global Call IP

Technology Guide

November 2007

05-2239-009

All contents of this document are furnished for informational use only and are subject to change without notice and do not represent a commitment on the part of Dialogic Corporation or its subsidiaries (“Dialogic”). Reasonable effort is made to ensure the accuracy of the information contained in the document. However, Dialogic does not warrant the accuracy of this information and cannot accept responsibility for errors, inaccuracies or omissions that may be contained in this document.

INFORMATION IN THIS DOCUMENT IS PROVIDED IN CONNECTION WITH DIALOGIC ESTOPPEL OR OTHERWISE, TO ANY INTELLECTUAL PROPERTY RIGHTS IS GRANTED BY THIS DOCUMENT. EXCEPT AS PROVIDED IN A SIGNED AGREEMENT BETWEEN YOU AND DIALOGIC, DIALOGIC ASSUMES NO LIABILITY WHATSOEVER, AND DIALOGIC DISCLAIMS ANY EXPRESS OR IMPLIED WARRANTY, RELATING TO SALE AND/OR USE OF DIALOGIC PRODUCTS INCLUDING LIABILITY OR WARRANTIES RELATING TO FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR INFRINGEMENT OF ANY INTELLECTUAL PROPERTY RIGHT OF A THIRD PARTY.

Dialogic products are not intended for use in medical, life saving, life sustaining, critical control or safety systems, or in nuclear facility applications.

It is possible that the use or implementation of any one of the concepts, applications, or ideas described in this document, in marketing collateral produced by or on web pages maintained by Dialogic may infringe one or more patents or other intellectual property rights owned by third parties. Dialogic does not provide any intellectual property licenses with the sale of Dialogic products other than a license to use such product in accordance with intellectual property owned or validly licensed by Dialogic and no such licenses are provided except pursuant to a signed agreement with Dialogic. More detailed information about such intellectual property is available from Dialogic’s legal department at 9800 Cavendish Blvd., 5th Floor, Montreal, Quebec, Canada H4M 2V9. Dialogic encourages all users of its products to procure all necessary intellectual property licenses

required to implement any concepts or applications and does not condone or encourage any intellectual property infringement and disclaims any responsibility related thereto. These intellectual property licenses may differ from country to country and it is the responsibility of those who develop the concepts or applications to be aware of and comply with different national license requirements.

Dialogic, Diva, Eicon, Eicon Networks, Dialogic Pro, EiconCard and SIPcontrol, among others, are either registered trademarks or trademarks of Dialogic. Dialogic's trademarks may be used publicly only with permission from Dialogic. Such permission may only be granted by Dialogic’s legal department at 9800 Cavendish Blvd., 5th Floor, Montreal, Quebec, Canada H4M 2V9. Any authorized use of Dialogic's trademarks will be subject to full respect of the trademark guidelines published by Dialogic from time to time and any use of Dialogic’s trademarks requires proper acknowledgement. Windows is a registered trademark of Microsoft Corporation in the United States and/or other countries. Other names of actual companies and products mentioned herein are the trademarks of their respective owners.

This document discusses one or more open source products, systems and/or releases. Dialogic is not responsible for your decision to use open source in connection with Dialogic products (including without limitation those referred to herein), nor is Dialogic responsible for any present or future effects such usage might have, including without limitation effects on your products, your business, or your intellectual property rights.

Publication Date: November 2007

Document Number: 05-2239-009

PRODUCTS. NO LICENSE, EXPRESS OR IMPLIED, BY

Dialogic® Global Call IP Technology Guide – November 2007

Dialogic Corporation

Revision History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

About This Publication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Purpose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Applicability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

How to Use This Publication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Related Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

1 IP Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

1.1 Introduction to VoIP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

1.2 H.323 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

1.2.1 H.323 Entities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

1.2.2 H.323 Protocol Stack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

1.2.3 Codecs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

1.2.4 Basic H.323 Call Scenario . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

1.2.5 Registration with a Gatekeeper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

1.2.6 H.323 Call Scenario via a Gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

1.3 SIP Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

1.3.1 Advantages of Using SIP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

1.3.2 SIP User Agents and Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

1.3.3 Basic SIP Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

1.3.4 Basic SIP Call Scenario . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

1.3.5 SIP Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

2 Dialogic

2.1 Dialogic

2.2 Architecture Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

2.3 Device Types and Usage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Global Call API Architecture for IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Global Call API over IP Architecture with a Host-Based Stack . . . . . . . . . . . . . 43

2.2.1 Host Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

2.2.2 Dialogic

2.2.3 IP Signaling Call Control Library (IPT CCLib) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

2.2.4 IP Media Call Control Library (IPM CCLib) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

2.2.5 IP Media Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

2.3.1 Device Types Used with IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

2.3.2 IPT Board Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

2.3.3 IPT Network Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

2.3.4 IPT Start Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Global Call API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

3 IP Call Scenarios . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

3.1 Basic Call Control Scenarios When Using IP Technology. . . . . . . . . . . . . . . . . . . . . . . . . 51

3.1.1 Basic Call Setup When Using H.323 or SIP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

3.1.2 Basic Call Teardown When Using H.323 or SIP. . . . . . . . . . . . . . . . . . . . . . . . . . 53

3.1.3 Call Setup Scenarios for Early Media . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

3.2 Call Transfer Scenarios When Using H.323 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

3.2.1 General Conditions for H.450.2 Call Transfers . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Dialogic® Global Call IP Technology Guide – November 2007 3 Dialogic Corporation

Contents

3.2.2 Endpoint Behavior in H.450.2 Blind Call Transfers . . . . . . . . . . . . . . . . . . . . . . . . 57

3.2.3 Successful H.450.2 Blind Call Transfer Scenario . . . . . . . . . . . . . . . . . . . . . . . . . 59

3.2.4 Unsuccessful H.450.2 Blind Call Transfer Scenarios . . . . . . . . . . . . . . . . . . . . . . 61

3.2.5 Endpoint Behavior in H.450.2 Supervised Call Transfer . . . . . . . . . . . . . . . . . . . . 66

3.2.6 Successful H.450.2 Supervised Call Transfer Scenario . . . . . . . . . . . . . . . . . . . . 67

3.2.7 Unsuccessful H.450.2 Supervised Transfer Scenarios . . . . . . . . . . . . . . . . . . . . . 69

3.3 Call Transfer Scenarios When Using SIP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

3.3.1 General Conditions for SIP Call Transfers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

3.3.2 Endpoint Behavior in Unattended SIP Call Transfers . . . . . . . . . . . . . . . . . . . . . . 75

3.3.3 Successful Unattended SIP Call Transfer Scenarios . . . . . . . . . . . . . . . . . . . . . . 78

3.3.4 Endpoint Behavior in Attended SIP Transfers . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

3.3.5 Successful SIP Attended Call Transfer Scenarios. . . . . . . . . . . . . . . . . . . . . . . . . 86

3.3.6 Unsuccessful Call Transfer Scenarios. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

3.4 T.38 Fax Server Call Scenarios . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

3.4.1 Sending T.38 Fax in an Established Audio Session . . . . . . . . . . . . . . . . . . . . . . . 98

3.4.2 Receiving T.38 Fax in an Established Audio Session . . . . . . . . . . . . . . . . . . . . . . 99

3.4.3 Sending T.38 Fax Without an Established Audio Session. . . . . . . . . . . . . . . . . . 101

3.4.4 Receiving T.38 Fax Without an Established Audio Session . . . . . . . . . . . . . . . . 102

3.4.5 Sending a Request to Switch From T.38 Fax to Audio . . . . . . . . . . . . . . . . . . . . 103

3.4.6 Receiving a Request to Switch From T.38 Fax to Audio . . . . . . . . . . . . . . . . . . . 104

3.4.7 Terminating a Call After a T.38 Fax Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

3.4.8 Recovering from a Session Switching Failure . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

4 IP-Specific Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

4.1 Call Control Library Initialization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

4.1.1 Setting a SIP Outbound Proxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

4.1.2 Configuring SIP Transport Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

4.1.3 Enabling and Disabling H.245 Tunneling (H.323) . . . . . . . . . . . . . . . . . . . . . . . . 114

4.2 Fast and Slow Call Setup Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

4.2.1 Setting the Call Setup Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

4.2.2 H.323 Fast Start and Slow Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116

4.2.3 H.323 Fast Start with Optional H.245 Channel . . . . . . . . . . . . . . . . . . . . . . . . . . 117

4.2.4 SIP Call Setup Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

4.2.5 Retrieving Coder Information from Call Offers. . . . . . . . . . . . . . . . . . . . . . . . . . . 119

4.3 Setting Call-Related Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

4.3.1 Overview of Setting Call-Related Information . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

4.3.2 Setting Coder Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

4.3.3 Specifying Nonstandard Data Information (H.323) . . . . . . . . . . . . . . . . . . . . . . . 128

4.3.4 Specifying Nonstandard Control Information (H.323) . . . . . . . . . . . . . . . . . . . . . 130

4.4 Connection Phase Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

4.4.1 Setting and Retrieving Disconnect Cause or Reason Values . . . . . . . . . . . . . . . 132

4.4.2 Setting Busy Reason Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

4.4.3 SIP Provisional (1xx) Responses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

4.4.4 SIP Redirection (3xx) Response Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

4.4.5 SIP Rejection Responses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

4.4.6 Configuring Proceeding Message Generation (H.323) . . . . . . . . . . . . . . . . . . . . 141

4.5 Retrieving Current Call-Related Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

4.5.1 Retrieving Nonstandard Data From Protocol Messages (H.323) . . . . . . . . . . . . 145

4.5.2 Examples of Retrieving Call-Related Information . . . . . . . . . . . . . . . . . . . . . . . . 145

4.6 Receiving Notification Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

4 Dialogic® Global Call IP Technology Guide – November 2007

Dialogic Corporation

Contents

4.6.1 Enabling and Disabling Unsolicited Notification Events . . . . . . . . . . . . . . . . . . . 154

4.6.2 Getting Media Streaming Status and Connection Information . . . . . . . . . . . . . . 155

4.6.3 Getting Notification of Underlying Protocol State Changes . . . . . . . . . . . . . . . . 157

4.7 Modifying an Existing SIP Call via re-INVITE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

4.7.1 Overview of the SIP re-INVITE Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

4.7.2 Enabling Application Access to re-INVITE Requests . . . . . . . . . . . . . . . . . . . . . 159

4.7.3 Receiving SIP re-INVITE Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

4.7.4 Responding to SIP re-INVITE Requests. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

4.7.5 Sending a SIP re-INVITE Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

4.7.6 Canceling a Pending re-INVITE Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

4.7.7 Updating Dialog Properties via re-INVITE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

4.7.8 Implementing Hold and Retrieve via SIP re-INVITE . . . . . . . . . . . . . . . . . . . . . . 167

4.8 Setting and Retrieving Q.931 Message IEs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

4.8.1 Enabling Access to Q.931 Message IEs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

4.8.2 Supported Q.931 Message IEs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

4.8.3 Setting Q.931 Message IEs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

4.8.4 Retrieving Q.931 Message IEs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

4.8.5 Common Usage Scenarios Involving Q.931 Message IEs . . . . . . . . . . . . . . . . . 171

4.9 Setting and Retrieving SIP Message Header Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

4.9.1 SIP Header Access Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

4.9.2 Enabling Access to SIP Header Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

4.9.3 Enabling Long Header Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

4.9.4 Registering SIP Header Fields to be Retrieved . . . . . . . . . . . . . . . . . . . . . . . . . 180

4.9.5 Setting SIP Header Fields for Outbound Messages . . . . . . . . . . . . . . . . . . . . . . 183

4.9.6 Retrieving SIP Message Header Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

4.10 Using MIME Bodies in SIP Messages (SIP-T). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188

4.10.1 SIP MIME Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188

4.10.2 Enabling and Configuring the SIP MIME Feature . . . . . . . . . . . . . . . . . . . . . . . . 191

4.10.3 Getting MIME Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

4.10.4 Sending MIME Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197

4.10.5 MIME Error Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200

4.11 Specifying Transport for SIP Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201

4.12 Handling SIP Transport Failures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202

4.13 Sending and Receiving SIP INFO Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

4.13.1 Sending an INFO Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

4.13.2 Receiving a Response to an INFO Message . . . . . . . . . . . . . . . . . . . . . . . . . . . 206

4.13.3 Receiving an INFO Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208

4.13.4 Responding to an INFO Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209

4.14 Sending and Receiving SIP OPTIONS Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

4.14.1 Default OPTIONS Behavior . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

4.14.2 Enabling Application Access to OPTIONS Messages . . . . . . . . . . . . . . . . . . . . 211

4.14.3 Sending OPTIONS Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212

4.14.4 Receiving Responses to OPTIONS Requests . . . . . . . . . . . . . . . . . . . . . . . . . . 215

4.14.5 Receiving OPTIONS Requests. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217

4.14.6 Responding to OPTIONS Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218

4.15 Using SIP SUBSCRIBE and NOTIFY Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222

4.15.1 Sending SUBSCRIBE Requests. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223

4.15.2 Receiving Responses to SUBSCRIBE Requests . . . . . . . . . . . . . . . . . . . . . . . . 225

4.15.3 Receiving SUBSCRIBE Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228

4.15.4 Responding to SUBSCRIBE Requests. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

Dialogic® Global Call IP Technology Guide – November 2007 5 Dialogic Corporation

Contents

4.15.5 Sending NOTIFY Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

4.15.6 Receiving Responses to NOTIFY Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234

4.15.7 Receiving NOTIFY Requests. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235

4.15.8 Responding to NOTIFY Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235

4.16 Handling DTMF. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237

4.16.1 Specifying DTMF Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238

4.16.2 Getting Notification of DTMF Detection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240

4.16.3 Generating DTMF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

4.16.4 Generating or Detecting DTMF Tones Using a Voice Resource. . . . . . . . . . . . . 241

4.17 Sending Nonstandard Protocol Messages (H.323) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242

4.17.1 Nonstandard UII Message (H.245) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243

4.17.2 Nonstandard Facility Message (Q.931) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244

4.17.3 Nonstandard Registration Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245

4.17.4 Sending Facility, UII, or Registration Message Scenario. . . . . . . . . . . . . . . . . . . 246

4.18 Using H.323 Annex M Tunneled Signaling Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . 247

4.18.1 Tunneled Signaling Message Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247

4.18.2 Enabling Tunneled Signaling Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249

4.18.3 Composing Tunneled Signaling Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250

4.18.4 Sending Tunneled Signaling Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252

4.18.5 Receiving Tunneled Signaling Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254

4.19 Retrieving User-to-User Information Elements from H.323 Messages . . . . . . . . . . . . . . . 258

4.19.1 Enabling Reception of User-to-User Information . . . . . . . . . . . . . . . . . . . . . . . . . 259

4.19.2 Retrieving UU-IEs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260

4.20 Specifying RTP Stream Establishment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262

4.21 Managing Quality of Service Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263

4.21.1 Alarm Source Object Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264

4.21.2 Retrieving the Media Device Handle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264

4.21.3 Setting QoS Threshold Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264

4.21.4 Retrieving QoS Threshold Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265

4.21.5 Handling QoS Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266

4.22 Registration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268

4.22.1 Registration Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268

4.22.2 Registration Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271

4.22.3 Sending and Receiving Nonstandard Registration Messages (H.323) . . . . . . . . 278

4.22.4 Registration Code Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279

4.22.5 Gatekeeper Registration Failure (H.323). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284

4.23 SIP Digest Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285

4.24 Using SIP Transport Layer Security (TLS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288

4.24.1 Overview of TLS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289

4.24.2 Configuring and Enabling TLS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296

4.24.3 Making Calls Using TLS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303

4.24.4 TLS Transport Failures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310

4.25 Call Transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310

4.25.1 Enabling Call Transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311

4.25.2 Dialogic

Global Call API Line Devices for Call Transfer . . . . . . . . . . . . . . . . . . 311

4.25.3 Incoming Transferred Call . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312

4.25.4 Call Transfer Glare Condition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313

4.25.5 Call Transfer When Using SIP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315

4.26 T.38 Fax Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320

4.26.1 T.38 Fax Server Support Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320

6 Dialogic® Global Call IP Technology Guide – November 2007

Dialogic Corporation

Contents

4.26.2 Specifying Manual Operating Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322

4.26.3 Initiating a Switch from Audio to T.38 Fax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322

4.26.4 Associating a T.38 Fax Device with a Media Device When a Fax Request is

Received . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323

4.26.5 Accepting/Rejecting a Request to Switch Between Audio and T.38 Fax . . . . . . 325

4.26.6 Sending a T.38 Fax in a Session Without Audio Established . . . . . . . . . . . . . . . 325

4.26.7 Receiving a T.38 Fax in a Session Without Audio Established . . . . . . . . . . . . . 326

4.26.8 Sending a Request to Switch from T.38 Fax to Audio . . . . . . . . . . . . . . . . . . . . 328

4.26.9 Receiving a Request to Switch from T.38 Fax to Audio . . . . . . . . . . . . . . . . . . . 329

4.26.10 Terminating a Call After a T.38 Fax Session . . . . . . . . . . . . . . . . . . . . . . . . . . . 330

4.27 Sending and Receiving V.17 Faxes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330

4.27.1 Sending G.711 Fax in an Established Audio Session . . . . . . . . . . . . . . . . . . . . 330

4.27.2 Receiving G.711 Fax in an Established Audio Session . . . . . . . . . . . . . . . . . . . 331

4.28 Using Object Identifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332

4.29 LAN Disconnection Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333

4.30 Setting Dialogic® IP Media Library Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335

5 Third Party Call Control (3PCC) Operations and Multimedia Support . . . . . . . . . . . . . . . . 337

5.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337

5.1.1 Third Party Call Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337

5.1.2 Global Call Library and IP Media Library for Third Party Call Control. . . . . . . . . 341

5.1.3 Session Description Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342

5.2 Global Call in Third Party Call Control Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343

5.2.1 Initializing the Library in Third Party Call Control Mode . . . . . . . . . . . . . . . . . . . 343

5.2.2 Interface Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344

5.2.3 Device Types and Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352

5.2.4 Using Fast Start and Slow Start Setup in Third Party Call Control Mode . . . . . . 352

5.2.5 Call Transfer Scenarios . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352

5.2.6 DTMF Transport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353

5.2.7 T.38 Fax and Tone Detection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353

5.3 Session Description Protocol Parser/Generator Example . . . . . . . . . . . . . . . . . . . . . . . . 353

5.4 Message Sequence Diagrams. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353

5.4.1 First Party Call Establishment in Third Party Call Control Mode. . . . . . . . . . . . . 354

5.4.2 Basic Third Party Call Control Establishment . . . . . . . . . . . . . . . . . . . . . . . . . . . 355

5.4.3 Alternate Third Party Call Control Establishment . . . . . . . . . . . . . . . . . . . . . . . . 358

5.4.4 Modifying the Coder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362

5.4.5 Cancelling a re-INVITE Request. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366

5.4.6 Receiving an Invalid Answer SDP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367

5.4.7 OPTIONS Request on an Active Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368

5.5 Processing Intraframe Requests for Video Streams . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371

5.5.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371

5.5.2 Requesting an I-Frame in SIP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372

5.5.3 Global Call Example Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372

6 Building Dialogic

Global Call API IP Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375

6.1 Header Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375

6.2 Required Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375

6.3 Required System Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376

7 Debugging Dialogic

Global Call API IP Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377

7.1 Debugging Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377

Dialogic® Global Call IP Technology Guide – November 2007 7 Dialogic Corporation

Contents

7.2 Configuring the Logging Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378

7.2.1 Configuration File Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378

7.2.2 Configuring the gc_h3r Logging Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379

7.2.3 Configuring SIP Stack Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382

7.2.4 Configuring H.323 Stack Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383

8 IP-Specific Function Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387

8.1 Dialogic

8.2 IP-Specific Dialogic

Global Call API Functions Supported by IP . . . . . . . . . . . . . . . . . . . . . . . . . . . 387

Global Call API Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394

gc_AcceptModifyCall( ) – accept proposed modification of call characteristics . . . . . . . . 396

gc_RejectModifyCall( ) – reject proposed modification of call attributes . . . . . . . . . . . . . 406

gc_ReqModifyCall( ) – request modification of call attributes. . . . . . . . . . . . . . . . . . . . . . 414

gc_SetAuthenticationInfo( ) – set IP authentication information . . . . . . . . . . . . . . . . . . . . 421

gc_SipAck( ) – acknowledge a SIP 200OK message in 3PCC mode . . . . . . . . . . . . . . . 424

gc_util_copy_parm_blk( ) – copy the specified GC_PARM_BLK . . . . . . . . . . . . . . . . . . . 428

gc_util_find_parm_ex( ) – find a parameter in a GC_PARM_BLK . . . . . . . . . . . . . . . . . . 430

gc_util_insert_parm_ref_ex( ) – insert a GC_PARM_BLK parameter by reference . . . . . 433

gc_util_next_parm_ex( ) – retrieve the next parameter in a GC_PARM_BLK . . . . . . . . . 436

INIT_GC_PARM_DATA_EXT( ) – initialize GC_PARM_DATA_EXT structure . . . . . . . . 439

INIT_IP_VIRTBOARD( ) – initialize IP_VIRTBOARD data structure . . . . . . . . . . . . . . . . 441

INIT_IPCCLIB_START_DATA( ) – initialize IPCCLIB_START_DATA structure . . . . . . . 443

8.3 Dialogic

Global Call API Function Variances for IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444

8.3.1 gc_AcceptCall( ) Variances for IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444

8.3.2 gc_AcceptInitXfer( ) Variances for IP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445

8.3.3 gc_AcceptXfer( ) Variances for IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446

8.3.4 gc_AnswerCall( ) Variances for IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447

8.3.5 gc_CallAck( ) Variances for IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448

8.3.6 gc_Close( ) Variances for IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448

8.3.7 gc_DropCall( ) Variances for IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448

8.3.8 gc_Extension( ) Variances for IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449

8.3.9 gc_GetAlarmParm( ) Variances for IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451

8.3.10 gc_GetCallInfo( ) Variances for IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452

8.3.11 gc_GetCTInfo( ) Variances for IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455

8.3.12 gc_GetResourceH( ) Variances for IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455

8.3.13 gc_GetXmitSlot( ) Variances for IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455

8.3.14 gc_InitXfer( ) Variances for IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455

8.3.15 gc_InvokeXfer( ) Variances for IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456

8.3.16 gc_Listen( ) Variances for IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460

8.3.17 gc_MakeCall( ) Variances for IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460

8.3.18 gc_OpenEx( ) Variances for IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476

8.3.19 gc_RejectInitXfer( ) Variances for IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477

8.3.20 gc_RejectXfer( ) Variances for IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478

8.3.21 gc_ReleaseCallEx( ) Variances for IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478

8.3.22 gc_ReqService( ) Variances for IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479

8.3.23 gc_RespService( ) Variances for IP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482

8.3.24 gc_SetAlarmParm( ) Variances for IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483

8.3.25 gc_SetConfigData( ) Variances for IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484

8.3.26 gc_SetUserInfo( ) Variances for IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487

8.3.27 gc_Start( ) Variances for IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491

8 Dialogic® Global Call IP Technology Guide – November 2007

Dialogic Corporation

Contents

8.3.28 gc_Stop( ) Variances for IP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494

8.3.29 gc_UnListen( ) Variances for IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495

8.4 Dialogic

8.5 Dialogic

Global Call API States Supported by IP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495

Global Call API Events Supported by IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495

9 IP-Specific Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499

9.1 Overview of Parameter Usage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499

9.2 Parameter Set Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510

9.2.1 GCSET_CALL_CONFIG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511

9.2.2 IPSET_CALLINFO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512

9.2.3 IPSET_CONFERENCE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514

9.2.4 IPSET_CONFIG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515

9.2.5 IPSET_DTMF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517

9.2.6 IPSET_EXTENSIONEVT_MSK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518

9.2.7 IPSET_FOIP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518

9.2.8 IPSET_H323_RESPONSE_CODE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519

9.2.9 IPSET_IPPROTOCOL_STATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519

9.2.10 IPSET_LOCAL_ALIAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520

9.2.11 IPSET_MEDIA_STATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521

9.2.12 IPSET_MIME and IPSET_MIME_200OK_TO_BYE. . . . . . . . . . . . . . . . . . . . . . 522

9.2.13 IPSET_MSG_H245. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523

9.2.14 IPSET_MSG_Q931 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523

9.2.15 IPSET_MSG_REGISTRATION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523

9.2.16 IPSET_MSG_SIP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524

9.2.17 IPSET_NONSTANDARDCONTROL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525

9.2.18 IPSET_NONSTANDARDDATA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526

9.2.19 IPSET_PROTOCOL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526

9.2.20 IPSET_REG_INFO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527

9.2.21 IPSET_RTP_ADDRESS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528

9.2.22 IPSET_SDP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528

9.2.23 IPSET_SIP_MSGINFO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529

9.2.24 IPSET_SIP_REQUEST_ERROR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531

9.2.25 IPSET_SIP_RESPONSE_CODE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532

9.2.26 IPSET_SUPPORTED_PREFIXES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533

9.2.27 IPSET_SWITCH_CODEC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533

9.2.28 IPSET_TRANSACTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534

9.2.29 IPSET_TUNNELEDSIGNALMSG. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535

9.2.30 IPSET_VENDORINFO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536

10 IP-Specific Data Structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 537

GC_PARM_DATA_EXT – retrieved parameter data . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538

IP_ADDR – local IP address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540

IP_AUDIO_CAPABILITY – basic audio capability information . . . . . . . . . . . . . . . . . . . . 541

IP_AUTHENTICATION – SIP digest authentication data . . . . . . . . . . . . . . . . . . . . . . . . 542

IP_CAPABILITY – basic capability information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543

IP_CAPABILITY_UNION – parameters for different capability categories . . . . . . . . . . . 545

IP_CONNECT – associate a Media device with a T.38 Fax device . . . . . . . . . . . . . . . . 546

IP_DTMF_DIGITS – DTMF information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 547

IP_DATA_CAPABILITY – basic data capability information . . . . . . . . . . . . . . . . . . . . . . 548

IP_H221NONSTANDARD – H.221 nonstandard data . . . . . . . . . . . . . . . . . . . . . . . . . . 549

Dialogic® Global Call IP Technology Guide – November 2007 9 Dialogic Corporation

Contents

IP_REGISTER_ADDRESS – gatekeeper registration information . . . . . . . . . . . . . . . . . . 550

IP_TUNNELPROTOCOL_ALTID – TSM protocol alternate ID. . . . . . . . . . . . . . . . . . . . . 551

IP_TUNNELPROTOCOL_OBJECTID – tunneled signaling protocol object ID . . . . . . . .552

IP_VIRTBOARD – information about an IPT board device . . . . . . . . . . . . . . . . . . . . . . . 553

IPCCLIB_START_DATA – IP call control library configuration information . . . . . . . . . . . 558

REQUEST_ERROR – SIP request retry info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560

RTP_ADDR – RTP address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 561

SIP_TLS_ENGINE – TLS engine configuration information. . . . . . . . . . . . . . . . . . . . . . . 562

11 IP-Specific Event Cause Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565

11.1 IP-Specific Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565

11.2 Error Codes When Using H.323 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569

11.3 Internal Disconnect Reasons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574

11.4 Event Cause Codes and Failure Reasons When Using H.323 . . . . . . . . . . . . . . . . . . . . 576

11.5 Failure Response Codes When Using SIP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 584

12 Supplementary Reference Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 591

12.1 References to More Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 591

12.2 SIP Transaction Timer Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 592

12.3 DNS Configuration for SIP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 593

12.4 Called and Calling Party Address List Format When Using H.323. . . . . . . . . . . . . . . . . . 594

Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 597

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599

10 Dialogic® Global Call IP Technology Guide – November 2007

Dialogic Corporation

Contents

Figures

1 Typical H.323 Network. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

2 H.323 Protocol Stack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

3 Basic H.323 Network with a Gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

4 Basic SIP Call Scenario. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

5 Dialogic® Global Call API Over IP Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

6 Dialogic® Global Call API Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

7 Configurations for Binding IPT Boards to NIC IP Addresses . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

8 Basic Call Setup When Using H.323 or SIP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

9 Basic Call Teardown When Using H.323 or SIP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

10 H.323 Early Media, FastStart Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

11 H.323 Early Media, SlowStart Mode with Early H.245 Enabled . . . . . . . . . . . . . . . . . . . . . . . . 55

12 SIP Early Media, Calling UA Offers SDP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

13 SIP Early Media, Calling UA Answers SDP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

14 Successful H.450.2 Blind Call Transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

15 H.450.2 Blind Call Transfer Failure - Party B Rejects Call Transfer . . . . . . . . . . . . . . . . . . . . . 61

16 H.450.2 Blind Call Transfer Failure - No Response from Party B . . . . . . . . . . . . . . . . . . . . . . . 62

17 H.450.2 Blind Call Transfer Failure - No Response from Party C . . . . . . . . . . . . . . . . . . . . . . . 63

18 H.450.2 Blind Call Transfer Failure - Party B Clears Primary Call Before Transfer is Completed.

19 H.450.2 Blind Call Transfer Failure - Party C is Busy When Transfer Attempted . . . . . . . . . . . 65

20 Successful H.450.2 Supervised Call Transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

21 H.450.2 Supervised Call Transfer Failure - Party C Timeout . . . . . . . . . . . . . . . . . . . . . . . . . . 70

22 H.450.2 Supervised Call Transfer Failure - Party C Rejects the Transfer Request. . . . . . . . . . 71

23 H.450.2 Supervised Call Transfer Failure - Party B Rejects the Transfer Request. . . . . . . . . . 72

24 H.450.2 Supervised Call Transfer Failure - Party B Timeout. . . . . . . . . . . . . . . . . . . . . . . . . . . 73

25 Successful SIP Unattended Call Transfer, Party A Notified with Connection . . . . . . . . . . . . . . 79

26 Successful SIP Unattended Call Transfer, Party A Notified with Ringing . . . . . . . . . . . . . . . . . 80

27 Successful SIP Unattended Call Transfer, Party B Terminates REFER Subscription

prior to Notification of Transferred Call Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

28 Successful SIP Unattended Call Transfer, Party A Clears Primary Call prior to Transfer

Completion. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

29 Successful SIP Unattended Call Transfer, Party B Clears Primary Call prior to Transfer

Completion. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

30 Successful SIP Attended Call Transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

31 SIP Attended Call Transfer, Recovery from REFER Unsupported . . . . . . . . . . . . . . . . . . . . . . 88

32 SIP Attended Call Transfer, Recovery from URI Not Routable . . . . . . . . . . . . . . . . . . . . . . . . . 89

33 SIP Call Transfer Failure - Party B Rejects Call Transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

34 SIP Call Transfer Failure - No Response from Party B . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

35 SIP Call Transfer Failure - No Initial NOTIFY After REFER is Accepted. . . . . . . . . . . . . . . . . . 92

36 SIP Call Transfer Failure - REFER Subscription Expires . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

37 SIP Call Transfer Failure - No Response from Party C . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

38 SIP Call Transfer Failure - Party B Drops Transferred Call Early . . . . . . . . . . . . . . . . . . . . . . . 95

Dialogic® Global Call IP Technology Guide – November 2007 11 Dialogic Corporation

Contents

39 SIP Call Transfer Failure - Party C is Busy When Transfer Attempted . . . . . . . . . . . . . . . . . . . 96

40 Sending T.38 Fax in an Established Audio Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

41 Receiving T.38 Fax in an Established Audio Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

42 Sending T.38 Fax Without an Established Audio Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

43 Receiving T.38 Fax Without an Established Audio Session . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

44 Sending a Request to Switch From T.38 Fax to Audio. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

45 Receiving a Request to Switch From T.38 Fax to Audio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

46 Terminating a Call After a T.38 Fax Transfer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

47 SIP MIME Scenario for Normal Call Setup and Teardown . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

48 SIP MIME Scenario for Rejected Call. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

49 SIP MIME GC_PARM_BLK Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

50 Sending Protocol Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .247

51 Outbound Proxy Configured for TLS Transport with Both IP and Hostname . . . . . . . . . . . . . . 304

52 Outbound Proxy Configured for TLS Transport with Only IP Address Or Hostname . . . . . . . . 305

53 TLS with “sip:” Source Address and “sip:” Destination Address . . . . . . . . . . . . . . . . . . . . . . . . 306

54 TLS with “sip:” Source Address and “sips:” Destination Address . . . . . . . . . . . . . . . . . . . . . . . 307

55 TLS with “sips:” Source Address and “sip:” Destination Address . . . . . . . . . . . . . . . . . . . . . . . 308

56 TLS with “sips” Source Address and “sips:” Destination Address . . . . . . . . . . . . . . . . . . . . . . 309

57 Global Call Devices for H.450.2 Blind Call Transfer or SIP Unattended Transfer . . . . . . . . . . 312

58 Global Call Devices for Supervised Call Transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312

59 Call Transfer Glare Condition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314

60 T.38 Fax Server Support in Manual Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321

61 Sending G.711 Fax in an Established Audio Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331

62 Receiving G.711 Fax in an Established Audio Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332

63 Third Party Call Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338

64 Basic Call Setup When Using Third Party Call Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339

65 Third Party Call Control Setup using re-INVITE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340

66 Global Call over IP Architecture for Third Party Call Control Mode . . . . . . . . . . . . . . . . . . . . . 342

67 First Party Call Control Establishment in Third Party Call Control Mode . . . . . . . . . . . . . . . . . 354

68 Basic Third Party Call Control Establishment (part one) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356

69 Basic Third Party Call Control Establishment (part two). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357

70 Alternate Third Party Call Control Establishment (part one). . . . . . . . . . . . . . . . . . . . . . . . . . . 359

71 Alternate Third Party Call Control Establishment (part two) . . . . . . . . . . . . . . . . . . . . . . . . . . . 360

72 Alternate Third Party Call Control Establishment (part three) . . . . . . . . . . . . . . . . . . . . . . . . . 361

73 Successfully Modifying the Coder (part one) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

74 Successfully Modifying the Coder (part two) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364

75 Unsuccessfully Modifying the Coder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365

76 Cancelling a Coder Switch using re-INVITE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366

77 Receiving an Invalid Answer SDP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368

78 OPTIONS Request without a MIME Body . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370

79 OPTIONS Request with a MIME Body . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371

12 Dialogic® Global Call IP Technology Guide – November 2007

Dialogic Corporation

Contents

Tables

1 Summary of Call-Related Information that can be Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

2 Coders Supported for Dialogic® Host Media Processing (HMP) Software . . . . . . . . . . . . . . . 127

3 Capabilities Set by Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

4 Retrievable Call Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

5 Supported Q.931 Message Information Elements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

6 Supported IEs in Incoming Q.931 Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

7 Common Usage Scenarios Involving Q.931 Message IEs . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

8 Common Header Fields in Outbound SIP Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

9 Common Header Fields in Inbound SIP Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

10 Field-Specific Parameters (Deprecated) for SIP Header Access . . . . . . . . . . . . . . . . . . . . . . 178

11 Parameter IDs for Partial Header Field Access (Deprecated) . . . . . . . . . . . . . . . . . . . . . . . . . 184

12 Global Call Events for Incoming SIP Messages that can Contain MIME Bodies. . . . . . . . . . . 192

13 Global Call Functions for SIP MIME Messages Using IPSET_MIME . . . . . . . . . . . . . . . . . . . 197

14 Summary of DTMF Mode Settings and Behavior . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240

15 Summary of Protocol Messages that Can be Sent with Nonstandard Data . . . . . . . . . . . . . . 242

16 H.225 Messages and Global Call Functions for Sending Tunneled Signaling Messages . . . . 253

17 H.225 Messages and Global Call Events for Receiving Tunneled Signaling Messages . . . . . 255

18 H.225 Messages and Global Call Events for Receiving UU-IE . . . . . . . . . . . . . . . . . . . . . . . . 259

19 SIP REGISTER Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270

20 IPSET_SDP Parameter Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346

21 Summary of IPSET_SDP Parameters and Outbound SIP Messages . . . . . . . . . . . . . . . . . . . 346

22 Summary of Events That Support Global Call SDP Parameter Sets. . . . . . . . . . . . . . . . . . . . 347

23 Global Call Third Party Call Control Mode Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350

24 Global Call Third Party Call Control Mode Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351

25 Global Call Functions Invalid in Third Party Call Control Mode . . . . . . . . . . . . . . . . . . . . . . . . 351

26 Valid Extension IDs for the gc_Extension( ) Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450

27 gc_InvokeXfer( ) Supported Parameters for H.450.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456

28 H.450.2 ctInitiate Errors Received from the Network. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457

29 H.450.2 ctIdentify Errors Received From the Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457

30 H.450.2 ctSetup Errors Received From the Network. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458

31 H.450.2 CT Timer Expiry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458

32 gc_InvokeXfer( ) Supported Parameters for SIP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459

33 SIP Header Fields Settable in REFER Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460

34 Configurable Call Parameters When Using H.323 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461

35 Configurable Call Parameters When Using SIP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464

36 ctIdentify Errors Signaled From gc_RejectInitXfer( ) to the Network . . . . . . . . . . . . . . . . . . . . 477

37 ctInitiate Errors Signaled From gc_RejectXfer( ) to the Network . . . . . . . . . . . . . . . . . . . . . . . 478

38 Registration Information When Using H.323 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480

39 Registration Information When Using SIP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482

40 Parameters Configurable Using gc_SetConfigData( ) When Using H.323 . . . . . . . . . . . . . . . 485

41 Parameters Configurable Using gc_SetConfigData( ) When Using SIP . . . . . . . . . . . . . . . . . 487

Dialogic® Global Call IP Technology Guide – November 2007 13 Dialogic Corporation

Contents

42 Summary of Parameter Sets and Parameter Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499

43 GCSET_CALL_CONFIG Parameter Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511

44 IPSET_CALLINFO Parameter Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512

45 IPSET_CONFERENCE Parameter Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514

46 IPSET_CONFIG Parameter Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515

47 IPSET_DTMF Parameter Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517

48 IPSET_EXTENSIONEVT_MSK Parameter Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518

49 IPSET_FOIP Parameter Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518

50 IPSET_H323_RESPONSE_CODE Parameter Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519

51 IPSET_IPPROTOCOL_STATE Parameter Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519

52 IPSET_LOCAL_ALIAS Parameter Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520

53 IPSET_MEDIA_STATE Parameter Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521

54 IPSET_MIME and IPSET_MIME_200OK_TO_BYE Parameter Sets. . . . . . . . . . . . . . . . . . . . 522

55 IPSET_MSG_H245 Parameter Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523

56 IPSET_MSG_Q931 Parameter Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523

57 IPSET_MSG_REGISTRATION Parameter Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523

58 IPSET_MSG_SIP Parameter Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524

59 IPSET_NONSTANDARDCONTROL Parameter Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525

60 IPSET_NONSTANDARDDATA Parameter Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526

61 IPSET_PROTOCOL Parameter Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526

62 IPSET_REG_INFO Parameter Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527

63 IPSET_RTP_ADDRESS Parameter Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528

64 IPSET_SDP Parameter Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529

65 IPSET_SIP_MSGINFO Parameter Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529

66 IPSET_SIP_REQUEST_ERROR Parameter Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531

67 IPSET_SIP_RESPONSE_CODE Parameter Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532

68 IPSET_SUPPORTED_PREFIXES Parameter Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533

69 IPSET_SWITCH_CODEC Parameter Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533

70 IPSET_TRANSACTION Parameter Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534

71 IPSET_TUNNELEDSIGNALMSG Parameter Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535

72 IPSET_VENDORINFO Parameter Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536

14 Dialogic® Global Call IP Technology Guide – November 2007

Dialogic Corporation

Revision History

This revision history summarizes the changes made in each published version of this document.

Document No. Publication Date Description of Revisions

05-2239-009 November 2007 Made global changes to reflect Dialogic brand.

05-2239-008 August 2006 Setting Coder Information: Added G.726 coder info

SIP Rejection Responses: New section

Using H.323 Annex M Tunneled Signaling Messages: Revised entire section for

updated implementation of feature

Retrieving User-to-User Information Elements from H.323 Messages: New section

and subsections

Using SIP Transport Layer Security (TLS): New section and subsections

Sending and Receiving V.17 Faxes: New section

gc_Stop( ) Variances for IP: New section

Summary of Parameter Sets and Parameter Usage table: Added entry for new

IPSET_CALLINFO/ IPPARM_UUIE_ASN1 and IPSET_CONFIG/ IPPARM_1PCC_REJECT_VIDEO parameters

IPSET_CALLINFO Parameter Set table : Added entry for new IPPARM_UUIE_ASN1

parameter

IPSET_CONFIG: Added entry for new IPPARM_1PCC_REJECT_VIDEO parameter

IP_TUNNELPROTOCOL_OBJECTID data structure : new reference page

IP_CAPABILITY data structure: Added capability value for G.726 coder

IP_VIRTBOARD data structure: Added information on limits for xxx_max_call values

in 3PCC mode. Added new UU-IE define for h323_msg_info field, new TLS define for E_SIP_OutboundProxyTransport field, and new sip_tls_engine field

SIP_TLS_ENGINE data structure: new reference page

SIP Transaction Timer Values: New section

DNS Configuration for SIP: New section

05-2239-007 December 2005 Call Setup Scenarios for Early Media: New section

Retrieving Coder Information from Fast Start Call Offers: New section

Setting Coder Information section: Added defines for half-duplex capabilities

Specifying Nonstandard Data Information (H.323): Updated for data >255 bytes

Specifying Nonstandard Control Information (H.323): Updated for data >255 bytes

Connection Phase Messages: New section to consolidate several existing topics

SIP Provisional (1xx) Responses : New section

SIP Redirection (3xx) Response Messages: New section

Receiving Notification Events: New section to consolidate 3 existing related topics

Getting Media Streaming Status and Connection Information section: Added parm

IDs for half-duplex and on-hold states

Modifying an Existing SIP Call (re-INVITE): New section and subsections

Field-Specific Parameters (Deprecated) for SIP Header Access table: Deleted five

unsupported IPPARM defines

Dialogic® Global Call IP Technology Guide — November 2007 15 Dialogic Corporation

Revision History

Document No. Publication Date Description of Revisions

05-2239-007 (continued)

Retrieving SIP Message Header Fields section: Added note on truncation of too-long

header fields

Sending Nonstandard Protocol Messages (H.323) : Updated for NS data >255 bytes

Using MIME Bodies in SIP Messages (SIP-T) section: Updated for MIME header

field parameters >255 bytes

Using H.323 Annex M Tunneled Signaling Messages section: Updated for NS data

>255 bytes. Updated defines for object IDs.

Registration Overview section: Updated description of H.323 unregistration behavior

Registration Code Examples section: Updated registration code example

Sending and Receiving Nonstandard Registration Messages (H.323) section:

updated for NS data > 255 bytes

Setting IP Media Library Parameters: New section

Global Call Functions Supported by IP section: Added entries for Global Call

functions that support non-IP technologies

Message Sequence Diagrams section: Removed notes about lack of support for the

ipm_ModifyMedia( ) function

gc_AcceptModifyCall( ) function: Updated to describe use in 1PCC mode

gc_RejectModifyCall( ) function: Updated to describe use in 1PCC mode

gc_ReqModifyCall( ) function: Updated to describe use in 1PCC mode

gc_util_copy_parm_blk( ) function: Updated parms supporting >255 byte data

gc_util_find_parm_ex( ) function: Updated parms supporting >255 byte data

gc_util_insert_parm_ref_ex( ) function : Updated parms suppor ting >255 byte data

gc_util_next_parm_ex( ) function: Updated parms supporting >255 byte data

INIT_GC_PARM_DATA_EXT( ) function: new reference page

gc_AcceptCall( ) Variances for IP: Added info about Q.931 Progress message

gc_Start( ) Variances for IP section: Corrected descriptions of default start-up

Summary of Parameter Sets and Parameter Usage table: Added new parm IDs to

IPSET_CONFIG, IPSET_MEDIA_STATE, & IPSET_SIP_RESPONSE_CODE. Deleted 5 unimplemented parm IDs from IPSET_SIP_MSGINFO.

IPSET_CONFIG Parameter Set table: Added new parm ID for IPML parameters and

new SIP-specific parameter value for IPPARM_OPERATING_MODE

IPSET_MEDIA_STATE Parameter Set table: Added four parm IDs for inactive and

half-duplex states

IPSET_MIME and IPSET_MIME_200OK_TO_BYE Parameter Sets table: Updated

for MIME part headers > 255 bytes

IPSET_NONSTANDARDCONTROL Parameter Set: Updated for data >255 bytes

IPSET_NONSTANDARDDATA Parameter Set table: Updated for data >255 bytes

IPSET_SIP_MSGINFO Parameter Set table: Deleted five unimplemented parm IDs

IPSET_SIP_RESPONSE_CODE Parameter Set table: Added new parm ID for

provisional response status codes

IPSET_TUNNELEDSIGNALMSG Parameter Set table: Updated for data >255 bytes

IP_CAPABILITY data structure: Added new direction defines for half-duplex, on-hold

streaming and FastStart coder info retrieval

IP_VIRTBOARD data structure: Updated descriptions of ..._max_calls fields. Added

FastStart coder info defines for message info masks

IPCCLIB_START_DATA data structure: Added new parms supporting >255 byte data

REQUEST_ERROR data structure: New reference page

16 Dialogic® Global Call IP Technology Guide — November 2007

Dialogic Corporation

Revision History

Document No. Publication Date Description of Revisions

05-2239-006 August 2005 Call Control Library Initialization section: Expanded information on items that can be

configured, including 3PCC mode

Fast Start and Slow Start Call Setup section : Added subsections with H.323 and SIP

specifics and notes on non-support in 3PCC mode

H.323 Fast Start with Optional H.245 Channel: new section

Summary of Call-Related Information that can be Set table: Added DiffServ field

Specifying Transport for SIP Messages section: Added info about missing events

caused by UDP packet loss

Sending an INFO Message: Corrected code example

Responding to an INFO Message section: Corrected code examples

Handling DTMF section: Added note about LBR coders

Third Party Call Control (3PCC) and Multimedia Support : New chapter

Global Call Functions Supported by IP section: Added entries for new

gc_xxxModifyCall( ) functions and gc_SipAck( )

gc_AcceptModifyCall( ): New SIP-specific function

gc_RejectModifyCall( ): New SIP-specific function

gc_ReqModifyCall( ): New SIP-specific function

gc_SipAck( ): New SIP-specific function

gc_AcceptCall( ) Variances for IP section: Added info on setting SIP response code

gc_DropCall( ) Variances for IP: Added info about missing GCEV_DISCONNECTED

events in SIP

gc_Extension( ) Variances for IP section: Added notes on 3PCC support

gc_MakeCall( ) Variances for IP section: Updated info on SIP timeout behavior.

Corrected names of fast start/slow start parameter values. Added parameter for optional H.245 channel feature.

Global Call Events Supported by IP section: Added events associated with optional

H.245 channel mode and new gc_xxxModifyCall( ) and gc_SipAck( ) functions

IP-Specific Parameters chapter: Updated entries for media-related parameter sets to

indicate non-support in 3PCC mode

Summary of Parameter Sets and Parameter Usage table: Added new parm IDs to

IPSET_CALLINFO (1), IPSET_IPPROTOCOL_STATE (1), IPSET_MSG_SIP (1), IPSET_SIP_RESPONSE_CODE (1). Added new IPSET_SDP (4 parm IDs)

IPSET_CALLINFO Parameter Set table: Added parm ID for optional H.245 channel

IPSET_CONFIG Parameter Set table: Added info on DiffServ field (DSCP)

IPSET_IPPROTOCOL_STATE Parameter Set table: Added parm for H.245 failure

IPSET_MSG_SIP Parameter Set table: Added IPPARM_SIP_METHOD parm ID

IPSET_SDP parameter set: New section

IPSET_SIP_RESPONSE_CODE Parameter Set table: Added

IPPARM_ACCEPT_RESP_CODE parm ID

IP_CAPABILITY data structure: Added new direction defines

Error Codes When Using H.323 section: Added new codes for H.245 channel error

Dialogic® Global Call IP Technology Guide — November 2007 17 Dialogic Corporation

Revision History

Document No. Publication Date Description of Revisions

05-2239-005 April 2005 Call Control Library Initialization section : Added more detail about how to set

configuration items before calling gc_Start( )

Setting and Retrieving SIP Message Header Fields section: Rewritten to document

generic access mechanism and long header support

Sending OPTIONS Requests section: added note on inclusion of MIME SDP body

Responding to OPTIONS Requests section : Added information about automatic

inclusion of SDP in MIME body of OK responses

Sending NOTIFY Requests section: Corrected code example

Using H.323 Annex M Tunneled Signaling Messages : New section and subsections

Registration section: Reorganized subsections and added information on new SIP

registration capabilities

SIP Digest Authentication: New section and subsections

Debugging Global Call IP Applications chapter: Added note in two locations about

SIP stack parsing error log file

Global Call Functions Supported by IP section: Added entries for

gc_SetAuthenticationInfo( ) and new gc_util_... functions

IP-Specific Global Call Functions: New section to contain API reference pages for:

gc_SetAuthenticationInfo( ) (new function), gc_util_copy_parm_blk( ) (new function), gc_util_find_parm_ex( ) (new function), gc_util_insert_parm_ref_ex( ) (new function), gc_util_next_parm_ex( ) (new function), INIT_IP_VIRTBOARD( ) INIT_IPCCLIB_START_DATA( )

Valid Extension IDs for the gc_Extension( ) Function table: Added note on parameter

order requirement when using IPEXTID_SENDMSG

gc_OpenEx( ) Variances for IP section: Added note about not closing and re-opening

channels (PTR# 32087)

gc_Start( ) Variances for IP section: Added information about how to reference

configuration data structure when calling function

Initialization Functions section: Eliminated section by moving information to API

reference pages in new IP-Specific Global Call Functions section

Summary of Parameter Sets and Parameter Usage table: Added two authentication

parameter IDs to IPSET_CONFIG. Added “deprecated” indication to all parameters in the IPSET_SIP_MSGINFO set except IPPARM_SIP_HDR. Added two new parameter IDs to IPSET_REG_INFO. Added six new entries for IPSET_TUNNELEDSIGNALMSG parameter set.

IPSET_CONFIG Parameter Set table: Added

IPPARM_AUTHENTICATION_CONFIGURE and IPPARM_AUTHENTICATION_REMOVE parameters

IPSET_SIP_MSGINFO section: Added note on deprecation of most parm IDs.

Added note about using extended gc_util_... functions with IPPARM_SIP_HDR

IPSET_SIP_MSGINFO Parameter Set table: Added “deprecated” indications to all

parameters except IPPARM_SIP_HDR

IPSET_REG_INFO Parameter Set table: Added IP_REG_QUERY_INFO value for

IPPARM_OPERATION_REGISTER parameter. Added IPPARM_REG_AUTOREFRESH and IPPARM_REG_SERVICEID parameters.

18 Dialogic® Global Call IP Technology Guide — November 2007

Dialogic Corporation

Revision History

Document No. Publication Date Description of Revisions

05-2239-005 (continued)

05-2239-004 January 2005 H.450.2 Blind Call Transfer Failure - Party B Rejects Call Transfer figure: Missing

IPSET_TUNNELEDSIGNALMSG parameter set: New section

GC_PARM_DATA_EXT data structure: New section

IP_AUTHENTICATION data structure : New section

IP_TUNNELPROTOCOL_ALTID data structure : New section

IP_VIRTBOARD data structure: Added new h323_msginfo_mask value for Annex M

tunneled signaling messages. Added sip_registration_registrar field.

IPCCLIB_START_DATA data structure: Added max_parm_data_size field

Failure Response Codes When Using SIP section: Added subsection for new SIP

Registration Error response codes

portion of figure restored

Endpoint Behavior in H.450.2 Supervised Call Transfer section: Added precondition

information, including parties in consultation call being in connected state

Call Transfer Scenarios When Using SIP: New section and subsections

Setting a SIP Outbound Proxy: New section

Configuring SIP Transport Protocol : New section and subsections

Retrieving Current Call-Related Information section: Added note about

acknowledging call before extracting information in H.323

Standard Call-Related SIP Message Header Fields table: Added entries for ten

additional headers

Standard Call-Related Headers for Outbound SIP Messages: New table showing

relationship between header s, Global Call functions, and SIP message types

Standard Call-Related Headers for Inbound SIP Messages: ANew table showing

relationship between SIP message types, Global Call event types, and headers

Setting Additional (Generic) SIP Message Headers: New section

Retrieving Additional (Generic) SIP Message Headers: New section

Using SIP Messages with MIME Bodies (SIP-T): New section and subsections

Global Call Events for Incoming SIP Messages that can Contain MIME Bodies table:

Added five additional message types. Event for 3xx to 6xx responses changed from GCEV_TASKFAIL to GCEV_DISCONNECTED.

Global Call Functions for SIP MIME Messages Using IPSET_MIME table: Added

one function and five additional message types

Specifying Transport for SIP Messages: new section

Handling SIP Transport Failures: new section

Sending and Receiving SIP INFO Messages: New section and subsections

Sending and Receiving SIP OPTIONS Messages: New section and subsections

Using SIP SUBSCRIBE and NOTIFY Messages: New section and subsections

Specifying DTMF Support section : Clarified descriptions of bitmask values

Getting Media Streaming Status and Connection Information section: Added

information on getting local and remote RTP addresses

Call Transfer When Using SIP: New section and subsection

Sending a T.38 Fax in a Session Without Audio Established section: Corrected code

example (PTR#33979)

Receiving a T.38 Fax in a Session Without Audio Established section: Corrected

code example (PTR#34073)

Dialogic® Global Call IP Technology Guide — November 2007 19 Dialogic Corporation

Revision History

Document No. Publication Date Description of Revisions

05-2239-004 (continued)

Host LAN Disconnection Alarms : New section and subsection

Debugging Global Call IP Applications chapter : Completely rewritten to describe new

RTF logging facilities

gc_AcceptInitXfer( ) Variances for IP section: Added SIP variances

gc_AcceptXfer( ) Variances for IP section: Added SIP variances

gc_Extension( ) Variances for IP section: Added IPEXTID_MSGINFO entry and

added SIP message type in entries for IPEXTID_RECEIVEMSG and IPEXTID_ SENDMSG in Valid Extension IDs for the gc_Extension( ) Function table

gc_GetCallInfo( ) Variances for IP section: Added info on SIP-specific forms of

origination address and destination address

gc_InitXfer( ) Variances for IP section: Added SIP variances

gc_InvokeXfer( ) Variances for IP section: Added SIP variances

gc_RejectInitXfer( ) Variances for IP section: Added SIP variances

gc_RejectXfer( ) Variances for IP section: Added SIP variances

gc_SetConfigData( ) Variances for IP: Added SIP variance about enabling call

transfer invoke acknowledge events

gc_Start( ) Variances for IP: Added bullet items with default value info for SIP MIME,

SIP outbound proxy, SIP transport protocol, SIP request retry, and SIP OPTIONS access configuration items

INIT_IP_VIRTBOARD( ) section: Added info on SIP MIME enable, SIP outbound

proxy, SIP transport protocol, SIP request retry, and SIP OPTIONS access

Summary of Parameter Sets and Parameter Usage table: Added

IPPARM_REGISTER_SIP_HDR in IPSET_CONFIG set; IPSET_MIME and IPSET_MIME200OK_TO_BYE sets (5 parameter IDs); IPSET_MSG_SIP set (2 parameter IDs); IPSET_RTP_ADDRESS set (2 parameter IDs); 10 parameter IDs in IPSET_SIP_MSGINFO plus additional function and event information; IPSET_SIP_REQUEST_ERROR (2 parameter IDs)

IPSET_CONFIG section: Added IPPARM_REGISTER_SIP_HDR

IPSET_MIME and IPSET_MIME_200OK_TO_BYE: New section

IPSET_MSG_SIP: New section

IPSET_RTP_ADDRESS: New section

IPSET_SIP_MSGINFO: Added 10 additional parameter IDs

IPSET_SIP_REQUEST_ERROR: New section

IP_ADDR structure description : Corrected structure name in text and typedef (was

IPADDR)

IP_VIRTBOARD structure description: Corrected data type of localIP field. Added

SIP MIME enable mask value and fields for SIP outbound proxy, SIP transport protocol, SIP request retry, and SIP OPTIONS access enable.

RTP_ADDR structure description: New section

20 Dialogic® Global Call IP Technology Guide — November 2007

Dialogic Corporation

Document No. Publication Date Description of Revisions

05-2239-003 September 2004 General Conditions for Call Transfers section : New section

Using Fast Start and Slow Start Setup section: Added note about H.323 fast start

when no coder is specified (PTR#33321)

Summary of Call-Related Information that can be Set table: Added note that

GC_SINGLECALL must be used for Call ID and SIP Message Information fields. Added entries for four additional SIP Message Information fields.

Retrievable Call Information table: Revised datatype for H.323 Call ID and added info

on SIP Call ID

Examples of Retrieving Call-Related Information section: Added code examples for

retrieving and parsing Call ID.

Supported SIP Message Information Fields table: Added entries for Call ID,

Diversion URI, Referred-By, and Replaces. Updated Contact URI entry to indicate setting is supported.

Nonstandard Registration Message section: Corrected parameters and added code

example

gc_GetCallInfo( ) Variances for IP section: Added information on getting Call ID.

Added SIP-specific address formats (To URI and From URI)

gc_MakeCall( ) Variances for IP section: Added note about SIP timeout

Configurable Call Parameters When Using H.323 table: Corrected value names for

IPPARM_CONNECTIONMETHOD. Added entry for IPSET_CALLINFO/IPPARM_CALLID.

Configurable Call Parameters When Using SIP table: Corrected value names for

IPPARM_CONNECTIONMETHOD. Added entry for IPSET_CALLINFO/IPPARM_CALLID.

gc_Start( ) Variances for IP section: Added information on default board instances

and parameter values

Summary of Parameter Sets and Parameter Usage table: Updated info for

IPSET_CALLINFO/IPPARM_CALLID. Added entries in IPSET_SIP_MSGINFO section for IPPARM_CALLID_HDR,

IPPARM_DIVERSION_URI, IPPARM_REFERRED_BY, and IPPARM_REPLACES.

Added set/send info for IPSET_SIP_MSGINFO/IPPARM_CONTACT_URI.

IPSET_CALLINFO Parameter Set table: Updated description of IPPARM_CALLID.

Corrected value names for IPPARM_CONNECTIONMETHOD.

IPSET_SIP_MSGINFO Parameter Set table: Added entries for

IPPARM_CALLID_HDR, IPPARM_DIVERSION_URI, IPPARM_REFERRED_BY, and IPPARM_REPLACES

Updated IPPARM_CONTACT_URI to indicate that setting is supported. Added length defines for all parameters.

IP_VIRTBOARD structure description: Added default values to field descriptions

Revision History

Dialogic® Global Call IP Technology Guide — November 2007 21

Dialogic Corporation

Revision History

Document No. Publication Date Description of Revisions

05-2239-002 April 2004 Summary of Call-Related Information that can be Set table : Added entries for Call

ID, MediaWaitForConnect, and PresentationIndicator.

Coders Supported for Host Media Processing (HMP) table: Corrected G.711 entries

to indicate VAD must be disabled (PTR 32576). Added row for G.729a. Corrected frame size for G.729a+b. Added row for T.38. (PTR 32623)

Setting Busy Reason Codes: New section.

Example of Retrieving Call-Related Information section: Corrected both example

programs

Generating or Detecting DTMF Tones Using a Voice Resource: New section

Setting QoS Threshold Values and Retrieving QoS Threshold Values: Corrected

ParmSetID name in both code examples (PTR 32690)

Registration section: Corrected code example for SIP registration; added table to

map abstract registrar registration concepts to SIP REGISTER elements

Gatekeeper Registration Failure: New section.

Global Call Functions Supported by IP section: Added bullet to indicate support for

gc_GetCTInfo( )

gc_GetCTInfo( ) Variances for IP section: New section

gc_MakeCall( ) Variances for IP section: Clarified procedure for setting protocol to

use on multi-protocol devices. Added information to Forming a Destination Address String section about specifying port address in TCP/IP destination addresses.

gc_ReqService( ) Variances for IP section: Added SIP support for alias

gc_SetUserInfo( ) Variances for IP section: Added note about not using this function

to set protocol to use on multi-protocol devices.

gc_Start( ) Variances for IP section: Added note regarding network adaptor

enabling/disabling. Added information about initialization functions and overriding defaults when appropriate.

Initialization Functions: New section

Summary of Parameter Sets and Parameter Usage table:

Added IPPARM_MEDIAWAITFORCONNECT, IPPARM_PRESENTATION_IND, and IPPARM_PROGRESS_IND parameters to IPSET_CALLINFO

Added IPSET_H323_RESPONSE_CODE/IPPARM_BUSY_CAUSE parameter Updated IPSET_LOCAL_ALIAS set entries to add SIP support Added IPSET_SIP_RESPONSE_CODE/IPPARM_BUSY_REASON parameter

Parameter Set Reference section: Added and updated data type and size information

for all parameter sets in section

IPSET_CALLINFO section: Added entries for 3 new parameters

IPSET_H323_RESPONSE_CODE: New section

IPSET_REG_INFO section: Added row for IPPARM_REG_TYPE

IPSET_SIP_MSGINFO section: Added section for parameters used when setting

and retrieving SIP Message Information fields

IPSET_SIP_RESPONSE_CODE: New section

IP_VIRTBOARD structure description: Updated to refer to INIT_IP_VIRTBOARD()

initialization function. Added sup_serv_mask, h323_msginfo_mask, and terminal_type fields (PTR 30491)

22 Dialogic® Global Call IP Technology Guide — November 2007

Dialogic Corporation

Document No. Publication Date Description of Revisions

05-2239-002 (continued)

05-2239-001 September 2003 Initial version of document.

IPADDR structure description: Added note that only supported ipv4 field value is

IP_CFG_DEFAULT. Added info about byte order for IPv4 addresses.

IPCCLIB_START_DATA structure description: Updated to refer to

INIT_ IPCCLIB_START_DATA() initialization function.

IP-Specific Event Cause Codes chapter: Updated descriptions of the possible event

causes (PTR 31213:

Revision History

Dialogic® Global Call IP Technology Guide — November 2007 23

Dialogic Corporation

Revision History

24 Dialogic® Global Call IP Technology Guide — November 2007

Dialogic Corporation

About This Publication

The following topics provide information about this publication.

• Purpose

• Applicability

• Intended Audience

• How to Use This Publication

• Related Information

Purpose

This publication documents the Dialogic® Global Call API for IP technology as it is implemented in Dialogic implementation in Dialogic documents.

This guide is for users of the Dialogic based IP H.323 or SIP technology. The Dialogic and supports IP Media control capability. This guide provides Dialogic specific information only and should be used in conjunction with the Dialogic Programming Guide and the Dialogic generic behavior of the Dialogic

Host Media Processing Software Release 3.1LIN. The Dialogic® Global Call API

System Release software is documented in a separate set of

Global Call API who are writing applications that use host-

Global Call API Library Reference, which describe the

Global Call API.

Global Call API provides call control capability

Global Call API IP-

Global Call API

Applicability

This document version (05-2239-009) is published for Dialogic® Host Media Processing Software Release 3.1LIN.

This document may also be applicable to other software releases (including service updates) on Linux or Windows determine whether this document is supported.

operating systems. Check the Release Guide for your software release to

Intended Audience

This guide is intended for:

• System Integrators

• Independent Software Vendors (ISVs)

• Value Added Resellers (VARs)

Dialogic® Global Call IP Technology Guide — November 2007 25 Dialogic Corporation

About This Publication

• Original Equipment Manufacturers (OEMs)

This publication assumes that the audience is familiar with the Windows

operating system and

has experience using the C programming language.

How to Use This Publication

This guide is divided into the following chapters:

• Chapter 1, “IP Overview”, gives a overview of VoIP technology and brief introductions to the

H.323 and SIP standards for novice users.

• Chapter 2, “Dialogic

Call API can be used with IP technology and provides an overview of the architecture.

• Chapter 3, “IP Call Scenarios”, provides some call scenarios that are specific to IP technology,

including scenarios for the call transfer supplementary service.

• Chapter 4, “IP-Specific Operations”, describes how to use Dialogic

perform IP-specific operations, such as setting call related information, registering with a registration server, sending and receiving protocol-specific messages, etc.

• Chapter 5, “Third Party Call Control (3PCC) Operations and Multimedia Support”, describes

the Dialogic

application is not a direct participant in calls.

• Chapter 6, “Building Dialogic

building Dialogic

• Chapter 7, “Debugging Dialogic

debugging Dialogic

• Chapter 8, “IP-Specific Function Information”, documents functions that are specific to the IP

technology and describes additional functionality or limitations for specific Dialogic Call API functions when used with IP technology.

• Chapter 9, “IP-Specific Parameters” provides a reference for IP-specific parameter set IDs and

their associated parameter IDs.

• Chapter 10, “IP-Specific Data Structures”, provides reference information for data structures

that are specific to the use of Dialogic

• Chapter 11, “IP-Specific Event Cause Codes” describes IP-specific event cause codes.

• Chapter 12, “Supplementary Reference Information” provides supplementary information

including technology references and formats for called and calling party addresses for H.323.

• A Glossary and an Index can be found at the end of the document.

Global Call API Architecture for IP”, describes how Dialogic® Global

Global Call API to

Global Call API library’s support for scenarios where the SIP call control

Global Call API applications that use IP technology.

Global Call API IP applications using RTF logging facilities.

Global Call API IP Applications” provides information for

Global

Global Call API with the IP technology.

Related Information

See the following for additional information:

• http://www.dialogic.com/manuals/ (for Dialogic® product documentation)

• http://www.dialogic.com/support/ (for Dialogic technical support)

26 Dialogic® Global Call IP Technology Guide — November 2007

Dialogic Corporation

• http://www.dialogic.com/ (for Dialogic® product information)

About This Publication

Dialogic® Global Call IP Technology Guide — November 2007 27

Dialogic Corporation

About This Publication

28 Dialogic® Global Call IP Technology Guide — November 2007

Dialogic Corporation

1.IP Overview

This chapter provides overview information about the following topics:

• Introduction to VoIP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

• H.323 Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

• SIP Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

1.1 Introduction to VoIP

Voice over IP (VoIP) can be described as the ability to make telephone calls and send faxes over IPbased data networks with a suitable Quality of Service (QoS). The voice information is sent in digital form using discrete packets rather than via dedicated connections as in the circuit-switched Public Switched Telephone Network (PSTN).

Currently, there are two major international groups defining standards for VoIP:

• International Telecommunications Union, Telecommunications Standardization Sector

(ITU-T), which has defined the following:

– Recommendation H.323, covering Packet-based Multimedia Communications Systems

(including VoIP)

• Internet Engineering Task Force (IETF), which has defined drafts of the several RFC (Request

for Comment) documents, including the following central document:

– RFC 3261, the Session Initiation Protocol (SIP)

The H.323 recommendation was developed in the mid 1990s and is a mature protocol.

SIP (Session Initiation Protocol) is an emerging protocol for setting up telephony, conferencing, multimedia, and other types of communication sessions on the Internet.

1.2 H.323 Overview

The H.323 specification is an umbrella specification for the implementation of packet-based multimedia over IP networks that cannot guarantee Quality of Service (QoS). This section discusses the following topics about H.323:

• H.323 Entities

• H.323 Protocol Stack

• Codecs

• Basic H.323 Call Scenario

• Registration with a Gatekeeper

• H.323 Call Scenario via a Gateway

Dialogic® Global Call IP Technology Guide — November 2007 29 Dialogic Corporation

IP Overview

1.2.1 H.323 Entities

The H.323 specification defines the entity types in an H.323 network including:

Terminal

An endpoint on an IP network that supports the real-time, two-way communication with another H.323 entity. A terminal supports multimedia coders/decoders (codecs) and setup and control signaling.

Gateway

Provides the interface between a packet-based network (for example, an IP network) and a circuit-switched network (for example, the PSTN). A gateway translates communication procedures and formats between networks. It handles call setup and teardown and the compression and packetization of voice information.

Gatekeeper

Manages a collection of H.323 entities in an H.323 zone controlling access to the network for H.323 terminals, Gateways, and MCUs and providing address translation. A zone can span a wide geographical area and include multiple networks connected by routers and switches. Typically there is only one gatekeeper per zone, but there may be an alternate gatekeeper for backup and load balancing. Typically, endpoints such as terminals, gateways, and other gatekeepers register with the gatekeeper.

Multipoint Control Unit (MCU)

An endpoint that supports conferences between three or more endpoints. An MCU can be a stand-alone unit or integrated into a terminal, gateway, or gatekeeper. An MCU consists of:

• Multipoint Controller (MC) – handles control and signaling for conferencing support

• Multipoint Processor (MP) – receives streams from endpoints, processes them, and

returns them to the endpoints in the conference

Figure 1 shows the entities in a typical H.323 network.

Figure 1. Typical H.323 Network

Terminal

LAN

Terminal

MCU

Gatekeeper

Gateway

Router

PSTN

Internet or

Intranet

30 Dialogic® Global Call IP Technology Guide — November 2007

Dialogic Corporation

+ 574 hidden pages

Dialogic 05-2239-009 User Manual

Specifications and Main Features

Frequently Asked Questions

User Manual

Contents

Figures

Tables

Revision History

About This Publication

1.IP Overview

1.1 Introduction to VoIP

1.2 H.323 Overview

1.2.1 H.323 Entities