Refer events

Functions
Int32	PortSIP.SIPCallbackEvents.onReceivedRefer (Int32 callbackIndex, Int32 callbackObject, Int32 sessionId, Int32 referId, String to, String from, StringBuilder referSipMessage)
Int32	PortSIP.SIPCallbackEvents.onReferAccepted (Int32 callbackIndex, Int32 callbackObject, Int32 sessionId)
Int32	PortSIP.SIPCallbackEvents.onReferRejected (Int32 callbackIndex, Int32 callbackObject, Int32 sessionId, String reason, Int32 code)
Int32	PortSIP.SIPCallbackEvents.onTransferTrying (Int32 callbackIndex, Int32 callbackObject, Int32 sessionId)
Int32	PortSIP.SIPCallbackEvents.onTransferRinging (Int32 callbackIndex, Int32 callbackObject, Int32 sessionId)
Int32	PortSIP.SIPCallbackEvents.onACTVTransferSuccess (Int32 callbackIndex, Int32 callbackObject, Int32 sessionId)
Int32	PortSIP.SIPCallbackEvents.onACTVTransferFailure (Int32 callbackIndex, Int32 callbackObject, Int32 sessionId, String reason, Int32 code)

Detailed Description

Function Documentation

onReceivedRefer()

Int32 PortSIP.SIPCallbackEvents.onReceivedRefer	(	Int32	callbackIndex,
		Int32	callbackObject,
		Int32	sessionId,
		Int32	referId,
		String	to,
		String	from,
		StringBuilder	referSipMessage
	)

This event will be triggered once receiving a REFER message.

Parameters

sessionId	The session ID of the call.
referId	The ID of the REFER message. Pass it to acceptRefer or rejectRefer
to	The refer target.
from	The sender of REFER message.
referSipMessage	The SIP message of "REFER". Pass it to "acceptRefer" function.

onReferAccepted()

Int32 PortSIP.SIPCallbackEvents.onReferAccepted	(	Int32	callbackIndex,
		Int32	callbackObject,
		Int32	sessionId
	)

This callback will be triggered once remote side called "acceptRefer" to accept the REFER.

Parameters

sessionId

The session ID of the call.

onReferRejected()

Int32 PortSIP.SIPCallbackEvents.onReferRejected	(	Int32	callbackIndex,
		Int32	callbackObject,
		Int32	sessionId,
		String	reason,
		Int32	code
	)

This callback will be triggered once remote side called "rejectRefer" to reject the REFER.

Parameters

sessionId	The session ID of the call.
reason	Reject reason.
code	Reject code.

onTransferTrying()

Int32 PortSIP.SIPCallbackEvents.onTransferTrying	(	Int32	callbackIndex,
		Int32	callbackObject,
		Int32	sessionId
	)

When the refer call is being processed, this event will be triggered.

Parameters

sessionId

The session ID of the call.

onTransferRinging()

Int32 PortSIP.SIPCallbackEvents.onTransferRinging	(	Int32	callbackIndex,
		Int32	callbackObject,
		Int32	sessionId
	)

When the refer call is ringing, this event will be triggered.

Parameters

sessionId

The session ID of the call.

onACTVTransferSuccess()

Int32 PortSIP.SIPCallbackEvents.onACTVTransferSuccess	(	Int32	callbackIndex,
		Int32	callbackObject,
		Int32	sessionId
	)

When the refer call succeeds, this event will be triggered. The ACTV means Active. For example: A established the call with B, and A transferred B to C. When C accepts the refer call, A will receive this event.

Parameters

sessionId

The session ID of the call.

onACTVTransferFailure()

Int32 PortSIP.SIPCallbackEvents.onACTVTransferFailure	(	Int32	callbackIndex,
		Int32	callbackObject,
		Int32	sessionId,
		String	reason,
		Int32	code
	)

When the refer call fails, this event will be triggered. The ACTV means Active. For example: A established the call with B, and A transfered B to C. When C rejects the refer call, A will receive this event.

Parameters

sessionId	The session ID of the call.
reason	The error reason.
code	The error code.