PortSIP VoIP SDK Manual for iOS  16.2
PortSIP features our newest, supported, quality-assured VoIP SDK used by Several hundred companies around the world for easy VoIP application develop and quality-assured code.
Functions

Functions

(void) - <PortSIPEventDelegate >::onReceivedRefer:referId:to:from:referSipMessage:
 
(void) - <PortSIPEventDelegate >::onReferAccepted:
 
(void) - <PortSIPEventDelegate >::onReferRejected:reason:code:
 
(void) - <PortSIPEventDelegate >::onTransferTrying:
 
(void) - <PortSIPEventDelegate >::onTransferRinging:
 
(void) - <PortSIPEventDelegate >::onACTVTransferSuccess:
 
(void) - <PortSIPEventDelegate >::onACTVTransferFailure:reason:code:
 

Detailed Description

Function Documentation

◆ onReceivedRefer:referId:to:from:referSipMessage:()

- (void PortSIPEventDelegate) onReceivedRefer: (long)  sessionId
referId: (long)  referId
to: (char *)  to
from: (char *)  from
referSipMessage: (char *)  referSipMessage 

This event will be triggered once receiving a REFER message.

Parameters
sessionIdThe session ID of the call.
referIdThe ID of the REFER message. Pass it to acceptRefer or rejectRefer.
toThe refer target.
fromThe sender of REFER message.
referSipMessageThe SIP message of "REFER". Pass it to "acceptRefer" function.

◆ onReferAccepted:()

- (void PortSIPEventDelegate) onReferAccepted: (long)  sessionId

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

Parameters
sessionIdThe session ID of the call.

◆ onReferRejected:reason:code:()

- (void PortSIPEventDelegate) onReferRejected: (long)  sessionId
reason: (char *)  reason
code: (int)  code 

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

Parameters
sessionIdThe session ID of the call.
reasonReason for rejecting.
codeRejecting code.

◆ onTransferTrying:()

- (void PortSIPEventDelegate) onTransferTrying: (long)  sessionId

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

Parameters
sessionIdThe session ID of the call.

◆ onTransferRinging:()

- (void PortSIPEventDelegate) onTransferRinging: (long)  sessionId

When the refer call rings, this event will be triggered.

Parameters
sessionIdThe session ID of the call.

◆ onACTVTransferSuccess:()

- (void PortSIPEventDelegate) onACTVTransferSuccess: (long)  sessionId

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

Parameters
sessionIdThe session ID of the call.

◆ onACTVTransferFailure:reason:code:()

- (void PortSIPEventDelegate) onACTVTransferFailure: (long)  sessionId
reason: (char *)  reason
code: (int)  code 

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

Parameters
sessionIdThe session ID of the call.
reasonThe error reason.
codeThe error code.