Zoiper softphone

ZOIPER softphone

API Documentation Version 2.04 (c)zoiper.com

CONTENTS
1. Introduction 2. Constants and enums 3. IIdefiskAccount interface 4. IIdefiskAPI interface 5. Release cause codes

ZOIPER BIZ API documentation 2007

www.zoiper.com

1

1. Introduction
Zoiper API interface is designed for use with programming languages, capable to connect to OLE Automation servers. Itspurpose is to provide control over Zoiper functions and events, so it could be embedded in other applications.

The API provided with Zoiper consists of several enum types and two dual interfaces, which provides the functionality needed by the application for using Zoiper.

The Automation server is registered in the system by executing the Zoiper executable with the /regserver parameter and isunregistered with /unregserver.

2. Constants and enums
TLineState - this enum type is used to hold one of the line state constants and represents the current state of a given line. It is used with the information events and cannot be set to a line. ⇒ The Line state constants are as follows: • • •

lsDown - there is no call on the line. Also indicates that a call has ended. lsDialing - the lineis dialing but still no meaningful state. lsActive - the line is active i.e. has voice activity from the remote side (probably IVR or some server side ringing sounds), but the call is not answered.

• • • •

lsRinging - there is an incoming call on the line. lsWaitForAnswer - the outgoing call is ringing on the remote side. lsUp - the call is on, both sides are hearing each other. This is theonly call state that can be transferred and put on hold. lsResolvingPort - resolving STUN port.

TRegistrationResult - this enum type holds information for a registration result, provided by the registration events ⇒ The Registration result constants are as follows:

rrRejected - registration is rejected by the server (unsuccessful).

ZOIPER BIZ API documentation 2007

www.zoiper.com

2rrAknowledged - registration is acknowledged by the server (successful). rrTimeout - no reply from the server.

TCodecs - this enum type represents the codecs that can be used by the phone. ⇒ The Codec constants are as follows: • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • •

cPCMU - G.711 u-law codec cGSM - GSM codec cG723 - not used cDVI4_8K - not used cDVI41_6K - not usedcLPC - not used cPCMA - G.711 a-law codec cG722 - not used cL16_2CH - not used cL16_1CH - not used cQCELP - not used cCN - not used cMPA - not used cG728 - not used cDVI4_11k - not used cDVI4_22k - not used cG729 - not used cCELB - not used cJPEG - not used cNV - not used cH261 - not used cMPV - not used cMP2T - not used cH263 - not used cSpeex_Narrow - SpeeX narrowband codec cSpeex_Wide - SpeeXwideband codec cSpeex_Ultra - SpeeX ultraband codec ciLBC_30 - iLBC codec(30ms frame) ciLBC_20 - iLBC codec(20ms frame) cTel_Event - not used cG726 - not used

ZOIPER BIZ API documentation 2007

www.zoiper.com

3

TDTMFCodes - this enum type describes the DTMF tone codes used by the phone. ⇒ DTMF codes are as follows:

dtmfc0 - DTMF tone digit 0; dtmfc1 - DTMF tone digit 1; dtmfc2 - DTMFtone digit 2; dtmfc3 - DTMF tone digit 3; dtmfc4 - DTMF tone digit 4; dtmfc5 - DTMF tone digit 5; dtmfc6 - DTMF tone digit 6; dtmfc7 - DTMF tone digit 7; dtmfc8 - DTMF tone digit 8; dtmfc9 - DTMF tone digit 9; dtmfcAsterisk - DTMF tone symbol asterisk(*); dtmfcPound - DTMF tone symbol pound(#); dtmfcA - DTMF tone letter A; dtmfcB - DTMF tone letter B; dtmfcC - DTMF tone letter C; dtmfcD - DTMFtone letter D.

TAccountTech - this enum represents the technology used by an account. • •

atSIP - account uses SIP protocol technology; atIAX - account uses IAX protocol technology.

TRegistrationState – this enum type describes the registration state of an account.

rsNotRegistered – the account is not registered; rsRegistering – the account is in process of registering; rsRegistered –...