Dialogic IP Phone 05-2239-009 User Manuals

Table of Contents

• Contents

  3
• Figures

  11
• Tables

  13
• Revision History

  15
• About This Publication

  25
• 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® Global Call API Architecture for IP

  43
  • 2.1 Dialogic® Global Call API over IP Architecture with a Host-Based Stack

    43
  • 2.2 Architecture Components

    44
    • 2.2.1 Host Application

      45
    • 2.2.2 Dialogic® Global Call API

      45
    • 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 Device Types and Usage

    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
• 4. IP-Specific Operations

  51
  • 4.1 Call Control Library Initialization

    52
    • 4.1.1 Setting a SIP Outbound Proxy

      53
    • 4.1.2 Configuring SIP Transport Protocol

      54
    • 4.1.3 Enabling and Disabling H.245 Tunneling (H.323)

      58
  • 4.2 Fast and Slow Call Setup Modes

    59
    • 4.2.1 Setting the Call Setup Mode

      59
    • 4.2.2 H.323 Fast Start and Slow Start

      60
    • 4.2.3 H.323 Fast Start with Optional H.245 Channel

      61
    • 4.2.4 SIP Call Setup Modes

      62
    • 4.2.5 Retrieving Coder Information from Call Offers

      63
  • 4.3 Setting Call-Related Information

    65
    • 4.3.1 Overview of Setting Call-Related Information

      66
    • 4.3.2 Setting Coder Information

      69
    • 4.3.3 Specifying Nonstandard Data Information (H.323)

      72
    • 4.3.4 Specifying Nonstandard Control Information (H.323)

      74
  • 4.4 Connection Phase Messages

    75
    • 4.4.1 Setting and Retrieving Disconnect Cause or Reason Values

      76
    • 4.4.2 Setting Busy Reason Codes

      76
    • 4.4.3 SIP Provisional (1xx) Responses

      78
    • 4.4.4 SIP Redirection (3xx) Response Messages

      80
    • 4.4.5 SIP Rejection Responses

      84
    • 4.4.6 Configuring Proceeding Message Generation (H.323)

      85
  • 4.5 Retrieving Current Call-Related Information

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

      89
    • 4.5.2 Examples of Retrieving Call-Related Information

      89
  • 4.6 Receiving Notification Events

    98
    • 4.6.1 Enabling and Disabling Unsolicited Notification Events

      98
    • 4.6.2 Getting Media Streaming Status and Connection Information

      99
    • 4.6.3 Getting Notification of Underlying Protocol State Changes

      101
  • 4.7 Modifying an Existing SIP Call via re-INVITE

    101
    • 4.7.1 Overview of the SIP re-INVITE Method

      102
    • 4.7.2 Enabling Application Access to re-INVITE Requests

      103
    • 4.7.3 Receiving SIP re-INVITE Requests

      103
    • 4.7.4 Responding to SIP re-INVITE Requests

      106
    • 4.7.5 Sending a SIP re-INVITE Request

      107
    • 4.7.6 Canceling a Pending re-INVITE Request

      109
    • 4.7.7 Updating Dialog Properties via re-INVITE

      110
    • 4.7.8 Implementing Hold and Retrieve via SIP re-INVITE

      111
  • 4.8 Setting and Retrieving Q.931 Message IEs

    113
    • 4.8.1 Enabling Access to Q.931 Message IEs

      113
    • 4.8.2 Supported Q.931 Message IEs

      114
    • 4.8.3 Setting Q.931 Message IEs

      114
    • 4.8.4 Retrieving Q.931 Message IEs

      114
    • 4.8.5 Common Usage Scenarios Involving Q.931 Message IEs

      115
  • 4.9 Setting and Retrieving SIP Message Header Fields

    116
    • 4.9.1 SIP Header Access Overview

      116
    • 4.9.2 Enabling Access to SIP Header Information

      123
    • 4.9.3 Enabling Long Header Values

      123
    • 4.9.4 Registering SIP Header Fields to be Retrieved

      124
    • 4.9.5 Setting SIP Header Fields for Outbound Messages

      127
    • 4.9.6 Retrieving SIP Message Header Fields

      129
  • 4.10 Using MIME Bodies in SIP Messages (SIP-T)

    132
    • 4.10.1 SIP MIME Overview

      132
    • 4.10.2 Enabling and Configuring the SIP MIME Feature

      135
    • 4.10.3 Getting MIME Information

      135
    • 4.10.4 Sending MIME Information

      141
    • 4.10.5 MIME Error Conditions

      144
  • 4.11 Specifying Transport for SIP Messages

    145
  • 4.12 Handling SIP Transport Failures

    146
  • 4.13 Sending and Receiving SIP INFO Messages

    149
    • 4.13.1 Sending an INFO Message

      149
    • 4.13.2 Receiving a Response to an INFO Message

      150
    • 4.13.3 Receiving an INFO Message

      152
    • 4.13.4 Responding to an INFO Message

      153
  • 4.14 Sending and Receiving SIP OPTIONS Messages

    154
    • 4.14.1 Default OPTIONS Behavior

      154
    • 4.14.2 Enabling Application Access to OPTIONS Messages

      155
    • 4.14.3 Sending OPTIONS Requests

      156
    • 4.14.4 Receiving Responses to OPTIONS Requests

      159
    • 4.14.5 Receiving OPTIONS Requests

      161
    • 4.14.6 Responding to OPTIONS Requests

      162
  • 4.15 Using SIP SUBSCRIBE and NOTIFY Messages

    166
    • 4.15.1 Sending SUBSCRIBE Requests

      167
    • 4.15.2 Receiving Responses to SUBSCRIBE Requests

      169
    • 4.15.3 Receiving SUBSCRIBE Requests

      172
    • 4.15.4 Responding to SUBSCRIBE Requests

      173
    • 4.15.5 Sending NOTIFY Requests

      175
    • 4.15.6 Receiving Responses to NOTIFY Requests

      178
    • 4.15.7 Receiving NOTIFY Requests

      179
    • 4.15.8 Responding to NOTIFY Requests

      179
  • 4.16 Handling DTMF

    181
    • 4.16.1 Specifying DTMF Support

      182
    • 4.16.2 Getting Notification of DTMF Detection

      184
    • 4.16.3 Generating DTMF

      185
    • 4.16.4 Generating or Detecting DTMF Tones Using a Voice Resource

      185
  • 4.17 Sending Nonstandard Protocol Messages (H.323)

    186
    • 4.17.1 Nonstandard UII Message (H.245)

      187
    • 4.17.2 Nonstandard Facility Message (Q.931)

      188
    • 4.17.3 Nonstandard Registration Message

      189
    • 4.17.4 Sending Facility, UII, or Registration Message Scenario

      190
  • 4.18 Using H.323 Annex M Tunneled Signaling Messages

    191
    • 4.18.1 Tunneled Signaling Message Overview

      191
    • 4.18.2 Enabling Tunneled Signaling Messages

      193
    • 4.18.3 Composing Tunneled Signaling Messages

      194
    • 4.18.4 Sending Tunneled Signaling Messages

      196
    • 4.18.5 Receiving Tunneled Signaling Messages

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

    202
    • 4.19.1 Enabling Reception of User-to-User Information

      203
    • 4.19.2 Retrieving UU-IEs

      204
  • 4.20 Specifying RTP Stream Establishment

    206
  • 4.21 Managing Quality of Service Alarms

    207
    • 4.21.1 Alarm Source Object Name

      208
    • 4.21.2 Retrieving the Media Device Handle

      208
    • 4.21.3 Setting QoS Threshold Values

      208
    • 4.21.4 Retrieving QoS Threshold Values

      209
    • 4.21.5 Handling QoS Alarms

      210
  • 4.22 Registration

    212
    • 4.22.1 Registration Overview

      212
    • 4.22.2 Registration Operations

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

      222
    • 4.22.4 Registration Code Examples

      223
    • 4.22.5 Gatekeeper Registration Failure (H.323)

      228
  • 4.23 SIP Digest Authentication

    229
  • 4.24 Using SIP Transport Layer Security (TLS)

    232
    • 4.24.1 Overview of TLS

      233
    • 4.24.2 Configuring and Enabling TLS

      240
    • 4.24.3 Making Calls Using TLS

      247
    • 4.24.4 TLS Transport Failures

      254
  • 4.25 Call Transfer

    254
    • 4.25.1 Enabling Call Transfer

      255
    • 4.25.2 Dialogic® Global Call API Line Devices for Call Transfer

      255
    • 4.25.3 Incoming Transferred Call

      256
    • 4.25.4 Call Transfer Glare Condition

      257
    • 4.25.5 Call Transfer When Using SIP

      259
  • 4.26 T.38 Fax Server

    264
    • 4.26.1 T.38 Fax Server Support Overview

      264
    • 4.26.2 Specifying Manual Operating Mode

      266
    • 4.26.3 Initiating a Switch from Audio to T.38 Fax

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

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

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

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

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

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

      273
    • 4.26.10 Terminating a Call After a T.38 Fax Session

      274
  • 4.27 Sending and Receiving V.17 Faxes

    274
    • 4.27.1 Sending G.711 Fax in an Established Audio Session

      274
    • 4.27.2 Receiving G.711 Fax in an Established Audio Session

      275
  • 4.28 Using Object Identifiers

    276
  • 4.29 LAN Disconnection Alarms

    277
  • 4.30 Setting Dialogic® IP Media Library Parameters

    279
• 3. IP Call Scenarios

  281
  • 3.1 Basic Call Control Scenarios When Using IP Technology

    281
    • 3.1.1 Basic Call Setup When Using H.323 or SIP

      282
    • 3.1.2 Basic Call Teardown When Using H.323 or SIP

      283
    • 3.1.3 Call Setup Scenarios for Early Media

      283
  • 3.2 Call Transfer Scenarios When Using H.323

    287
    • 3.2.1 General Conditions for H.450.2 Call Transfers

      287
    • 3.2.2 Endpoint Behavior in H.450.2 Blind Call Transfers

      287
    • 3.2.3 Successful H.450.2 Blind Call Transfer Scenario

      289
    • 3.2.4 Unsuccessful H.450.2 Blind Call Transfer Scenarios

      291
    • 3.2.5 Endpoint Behavior in H.450.2 Supervised Call Transfer

      296
    • 3.2.6 Successful H.450.2 Supervised Call Transfer Scenario

      297
    • 3.2.7 Unsuccessful H.450.2 Supervised Transfer Scenarios

      299
  • 3.3 Call Transfer Scenarios When Using SIP

    304
    • 3.3.1 General Conditions for SIP Call Transfers

      304
    • 3.3.2 Endpoint Behavior in Unattended SIP Call Transfers

      305
    • 3.3.3 Successful Unattended SIP Call Transfer Scenarios

      308
    • 3.3.4 Endpoint Behavior in Attended SIP Transfers

      314
    • 3.3.5 Successful SIP Attended Call Transfer Scenarios

      316
    • 3.3.6 Unsuccessful Call Transfer Scenarios

      320
  • 3.4 T.38 Fax Server Call Scenarios

    327
    • 3.4.1 Sending T.38 Fax in an Established Audio Session

      328
    • 3.4.2 Receiving T.38 Fax in an Established Audio Session

      329
    • 3.4.3 Sending T.38 Fax Without an Established Audio Session

      331
    • 3.4.4 Receiving T.38 Fax Without an Established Audio Session

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

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

      334
    • 3.4.7 Terminating a Call After a T.38 Fax Session

      335
    • 3.4.8 Recovering from a Session Switching Failure

      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
  • 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® Global Call API Functions Supported by IP

    387
  • 8.2 IP-Specific Dialogic® Global Call API Functions

    394
    • gc_AcceptModifyCall( )

      396
    • gc_RejectModifyCall( )

      406
    • gc_ReqModifyCall( )

      414
    • gc_SetAuthenticationInfo( )

      421
    • gc_SipAck( )

      424
    • gc_util_copy_parm_blk( )

      428
    • gc_util_find_parm_ex( )

      430
    • gc_util_insert_parm_ref_ex( )

      433
    • gc_util_next_parm_ex( )

      436
    • INIT_GC_PARM_DATA_EXT( )

      439
    • INIT_IP_VIRTBOARD( )

      441
    • INIT_IPCCLIB_START_DATA( )

      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.3.28 gc_Stop( ) Variances for IP

      494
    • 8.3.29 gc_UnListen( ) Variances for IP

      495
  • 8.4 Dialogic® Global Call API States Supported by IP

    495
  • 8.5 Dialogic® 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

    538
  • IP_ADDR

    540
  • IP_AUDIO_CAPABILITY

    541
  • IP_AUTHENTICATION

    542
  • IP_CAPABILITY

    543
  • IP_CAPABILITY_UNION

    545
  • IP_CONNECT

    546
  • IP_DTMF_DIGITS

    547
  • IP_DATA_CAPABILITY

    548
  • IP_H221NONSTANDARD

    549
  • IP_REGISTER_ADDRESS

    550
  • IP_TUNNELPROTOCOL_ALTID

    551
  • IP_TUNNELPROTOCOL_OBJECTID

    552
  • IP_VIRTBOARD

    553
  • IPCCLIB_START_DATA

    558
  • REQUEST_ERROR

    560
  • RTP_ADDR

    561
  • SIP_TLS_ENGINE

    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