SIP_INCOMING_CALL_INFO

 

The SIP_INCOMING_CALL_INFO structure defines the information an application can request when an in coming call is received.

 

 

typedef struct

{

// Source information

char *pFromHeader;

char *pSrcUrl;

char *pSrcDisplayName;

char *pSrcUserName;
char *pSrcContactUserName;

char *pSrcHost;

DWORD SrcPort;

 

char *pReceivedIpAddress;

DWORD ReceivedPort;

 

// Destination information

char *pToHeader;

char *pDestUrl;

char *pDestUserName;

char *pDestHost;
 

// Call ID
char *pCallId;

 

// Other information

char *pOriginatingEngineId;

 

}SIP_INCOMING_CALL_INFO;

 

 

 

Members:

 

pFromHeader

This character array allows application software to access the SIP "From:" header that is contained in received INVITE messages.

 

pSrcUrl

This character array contains the SIP URL of the person calling us. Please refer to the installed SIP RFCs for a description of the format of SIP URLs (RFC 3261). The information contained in this URL is equivalent to the information that is present in the received INVITE message "From:" header.

 

pSrcDisplayName

The display name of the source of the phone call. This string may be empty if the far end that is initiating the call does not have a display name assigned.

 

pSrcUserName

The name of the IP phone/device that initiated this call. This is the same as the user name specified in the SIP "From:" header.

 

pSrcContactUserName

The name of the IP phone/device that initiated this call. This is the same as the user name specified in the SIP "Contact:" header.

 

pSrcHost

The host name of the IP phone/device that initiated this call.

 

SrcPort

The sending port of the IP phone/device that initiated this call.

 

pReceivedIpAddress

The detected IP address the far end used to originate the phone call.

 

ReceivedPort

The detected port the far end used to originate the phone call.

 

pToHeader

This character array allows application software to access the SIP "To:" header that is contained in received INVITE messages.

 

pDestUrl

This character array contains the SIP URL for the destination of the phone call. If you are developing a PSTN gateway, you will use this member to get the PSTN phone number. Most applications can ignore this member. Please refer to the installed SIP RFCs for a description of the format of SIP URLs (RFC 3261).

 

pDestUserName

The destination user name of the phone call.

 

pDestHost

The host name of the call destination.

 

pCallId

The call ID for the call.
 

pOriginatingEngineId

If the originator of the phone call is another LanScape VOIP Media Engine, this is the unique ID of that media engine. Application software can ignore this ID value.