# OpalStatusIncomingCall Struct Reference

`#include <opal.h>`

Collaboration diagram for OpalStatusIncomingCall:

[legend]

## Data Fields

const char * | m_callToken
| Call token for new call.
const char * | m_localAddress
| URL of local interface. e.g. "sip:me@here.com".
const char * | m_remoteAddress
| URL of calling party. e.g. "sip:them@there.com".
const char * | m_remotePartyNumber
| This is the E.164 number of the caller, if available.
const char * | m_remoteDisplayName
| Display name calling party. e.g. "Fred Nurk".
const char * | m_calledAddress
| URL of called party the remote is trying to contact.
const char * | m_calledPartyNumber
| This is the E.164 number of the called party, if available.
OpalProductDescription | m_product
const char * | m_alertingType
const char * | m_protocolCallId
const char * | m_referredByAddress
| This is the full address of the party doing transfer, if available.
const char * | m_redirectingNumber
| This is the E.164 number of the party doing transfer, if available.

## Detailed Description

Incoming call information for the OpalIndIncomingCall indication. This is only returned from the OpalGetMessage() function.

## Field Documentation

const char* OpalStatusIncomingCall::m_alertingType

The type of "distinctive ringing" for the call. The string is protocol dependent, so the caller would need to be aware of the type of call being made. Some protocols may ignore the field completely.

For SIP this corresponds to the string contained in the "Alert-Info" header field of the INVITE. This is typically a URI for the ring file.

For H.323 this must be a string representation of an integer from 0 to 7 which will be contained in the Q.931 SIGNAL (0x34) Information Element.

const char* OpalStatusIncomingCall::m_calledAddress

URL of called party the remote is trying to contact.

const char* OpalStatusIncomingCall::m_calledPartyNumber

This is the E.164 number of the called party, if available.

const char* OpalStatusIncomingCall::m_callToken

Call token for new call.

const char* OpalStatusIncomingCall::m_localAddress

URL of local interface. e.g. "sip:me@here.com".

OpalProductDescription OpalStatusIncomingCall::m_product

Product description data

const char* OpalStatusIncomingCall::m_protocolCallId

ID assigned by the underlying protocol for the call. Only available in version 18 and above

const char* OpalStatusIncomingCall::m_redirectingNumber

This is the E.164 number of the party doing transfer, if available.

const char* OpalStatusIncomingCall::m_referredByAddress

This is the full address of the party doing transfer, if available.

const char* OpalStatusIncomingCall::m_remoteAddress

URL of calling party. e.g. "sip:them@there.com".

const char* OpalStatusIncomingCall::m_remoteDisplayName

Display name calling party. e.g. "Fred Nurk".

const char* OpalStatusIncomingCall::m_remotePartyNumber

This is the E.164 number of the caller, if available.

The documentation for this struct was generated from the following file:

- opal.h