PCBEST NETWORK Robust SIP ActiveX Reference

Methods

1. SetZone
Give your site domain. It will be helpful to distinguish your webphone configuration from others.

2. SetConfigValue
Set configuration items.
Format: SetConfigValue "item_name", "Item_value"
Please click to get pre-configured items.

3. MakeCall
Make a call out.
Format: MakeCall ch, CalledNum, CallerNum
ch: channel index (0 or 1)
CalledNum: call destionation. sample: "sip:123@abc.com"
CallerNum: call from. It can be "".

4. AnswerCall
Answer an incoming call. It can be used in OnCallOffered event to answer a call.
Format: AnswerCall ch
ch: channel index (0 or 1)

5. HungupCall
Hung up a call.
Format: HungupCall ch
ch: channel index (0 or 1)

6. HoldCall
Hold or unhold a call.
Format: HoldCall ch
ch: channel index (0 or 1)

7. TransferCall
Transfer a call.
Format: TransferCall ch, Transferee
ch: channel index (0 or 1)
Transferee: the sip address of transferee. sample: "sip:456@def.ca".

8. SendDTMF
Send DTMF string when a call is connected.
Format: SendDTMF ch, DTMFStr
ch: channel index (0 or 1)
DTMFStr: DTMF string. Sample: "2", "4#", "1*".

Events:

1. OnPhoneReady
Phone loaded in page event.
Format: OnPhoneReady(long PhoneStatus)
PhoneStatus: 1 = successfully. 0 = failed.

2. OnCallOffered
A new call coming in. You can use AnswerCall to accept or HungupCall to reject.
Format: OnCallOffered(long ChanID, BSTR Caller, BSTR Callee, BSTR DestAddr, BSTR ViaAddr, BSTR SrcIPAddr, short SrcIPPort)
ChanID: channel index (0 or 1)
Caller: Caller's address
Callee: Callee's address
DestAddr: The real address the call wants to reach.
ViaAddr: The via address of SIP proxy.
SrcIPAddr: Message from which ip address.
SrcIPPort: Message from which ip port.

3. OnCallConnected
A new call coming in. You can use AnswerCall to accept or HungupCall to reject.
Format: OnCallConnected(long ChanID)
ChanID: channel index (0 or 1)

4. OnCallDialing
The channel is dialing out. You get this event when you initiate MakeCall method.
Format: OnCallDialing(long ChanID, BSTR sCaller, BSTR sCallee)
ChanID: channel index (0 or 1)
Caller: Caller's address
Callee: Callee's address

5. OnCallIdle
The channel is idle.
Format: OnCallIdle(long ChanID)
ChanID: channel index (0 or 1)

6. OnCallRinging
The remote side is ringing.
Format: OnCallRinging(long ChanID)
ChanID: channel index (0 or 1)

7. OnSIPRegStatus
This event notify you that if your SIP account registered successfully.
Format: OnSIPRegStatus(long UserID, long Status, long Expires)
UserID: SIP account id. based on 0.
Status: 1 = successfully registered. 0 = failed.
Expires: If registered successfully, how long(seconds) it is.

8. OnCallHolding
Notify channel is holding or not.
Format: OnCallHolding(long ChanID, long HoldOn)
ChanID: channel index (0 or 1)
HoldOn: 1 = holding, 0 = not holding.

9. OnCallTransfering
Call is transfering to a new address.
Format: OnCallTransfering(long ChanID, BSTR DestAddr)
ChanID: channel index (0 or 1)
DestAddr: new address.

10. OnNotifySimpleMsgSummary
Voice mail message event.
Format: OnNotifySimpleMsgSummary(BSTR MsgWaiting, BSTR MsgAccount, BSTR VoiceMsg)
MsgWaiting: how many message waiting
MsgAccount: sip account
VoiceMsg: voice mail message