Call Data Structures


Files

file  TelCall.h
 This file serves as a "C" header file defines structures for Tapi Call Services.
It contains a sample set of constants, enums, structs that would be required by applications.

Data Structures

struct  TelCallCugInfo_t
struct  TelCallingNameInfo_t
struct  TelCallUusInfo_t
struct  TelCallSetupParams_t
struct  TelCallStatus_t
struct  TelCallUserDataInfo_t
struct  TelCallEndInfo_t
struct  TelCallRedirectionInfo_t
struct  TelCallIncomingCallInfo_t

Defines

#define TAPI_CALLING_NAME_SIZE_MAX   80
#define TAPI_CALL_UUS_DATA_LEN_MAX   131

Enumerations

enum  TelCallCause_t {
  TAPI_CAUSE_SUCCESS, TAPI_CAUSE_ACCESSDISCARD, TAPI_CAUSE_BARR_BYOPERATOR, TAPI_CAUSE_BEARERMODE_NOTIMPL,
  TAPI_CAUSE_BEARERMODE_RESTRICTED, TAPI_CAUSE_BEARERMODE_UNAUTH, TAPI_CAUSE_BEARERMODE_UNAVAIL, TAPI_CAUSE_BUSY,
  TAPI_CAUSE_CALLMETER_EXPIRED, TAPI_CAUSE_CALLNO_ERROR, TAPI_CAUSE_CKTUNAVAIL, TAPI_CAUSE_CONGESTION,
  TAPI_CAUSE_NO_CIRCUIT_AVAIL, TAPI_CAUSE_DESTIN_INCOMPAT, TAPI_CAUSE_DTMF_NOSPEECH, TAPI_CAUSE_DTMF_REJECTED,
  TAPI_CAUSE_FACILITY_NOTIMPL, TAPI_CAUSE_FACILITY_NOTSUBSCRIBED, TAPI_CAUSE_INCOMINGCUGCALLS_BARRED, TAPI_CAUSE_INVALNUM,
  TAPI_CAUSE_MPTY_ERROR, TAPI_CAUSE_NOANSWER, TAPI_CAUSE_NONCUGMEMBER, TAPI_CAUSE_NUMBERCHANGED,
  TAPI_CAUSE_NUMBER_ERROR, TAPI_CAUSE_NWFAILURE, TAPI_CAUSE_OPERATIONUNAVAIL, TAPI_CAUSE_OUTOFORDER,
  TAPI_CAUSE_PROTOCOL_ERROR, TAPI_CAUSE_QOSUNAVAIL, TAPI_CAUSE_REJECT, TAPI_CAUSE_REJ_FAIL,
  TAPI_CAUSE_REJ_SRVC_NOT_AVL, TAPI_CAUSE_REMOTE_CKTUNAVAIL, TAPI_CAUSE_RESOURCEUNAVAIL, TAPI_CAUSE_SERVICEID_ERROR,
  TAPI_CAUSE_SERVICE_NOTIMPL, TAPI_CAUSE_SERVICE_UNAVAIL, TAPI_CAUSE_MODIFY_SAME_BEARER, TAPI_CAUSE_MODIFY_NOT_PERMITTED,
  TAPI_CAUSE_HOLD_FAIL, TAPI_CAUSE_TEMPFAILURE, TAPI_CAUSE_WRONGNUM, TAPI_CAUSE_NORMAL_UNSPECIFIED,
  TAPI_CAUSE_SSERRINVALIDTIVALUE, TAPI_CAUSE_SSERRINVALIDTI, TAPI_CAUSE_SSINCOMPATIBLESTATE, TAPI_CAUSE_SSERRSYNTAXERROR,
  TAPI_CAUSE_SSPROTOCOLERROR, TAPI_CAUSE_SSNEGATIVEPASSWORDCHECK, TAPI_CAUSE_SSSENTASPHASE1, TAPI_CAUSE_SSERROR,
  TAPI_CAUSE_SS_USSD_BUSY, TAPI_CAUSE_IDLE, TAPI_CAUSE_NETWORK_SPECIFIC, TAPI_CAUSE_FADE,
  TAPI_CAUSE_UNKNOWN, TAPI_CAUSE_INCOM_CALL, TAPI_CAUSE_ALERT_STOP, TAPI_CAUSE_INTERCEPT,
  TAPI_CAUSE_REORDER, TAPI_CAUSE_CLIENT_END, TAPI_CAUSE_ACCESS_CLASS_BLOCKED, TAPI_CAUSE_MEMCAPEXCEEDED,
  TAPI_CAUSE_TYPENOTSUPPORTED, TAPI_CAUSE_REPLACENOTSUPPORTED, TAPI_CAUSE_PROTOCOLID_ERROR, TAPI_CAUSE_CLASSNOTSUPPORTED,
  TAPI_CAUSE_DATACODING_ERROR, TAPI_CAUSE_INVAL_MSG, TAPI_CAUSE_CALL_BARRED, TAPI_CAUSE_SIM_CALL_CONTROL_CHANGED_TO_SS,
  TAPI_CAUSE_SIM_CALL_CONTROL_CHANGED_TO_CALL, TAPI_CAUSE_SIM_ERROR, TAPI_CAUSE_SIM_CALL_CONTROL_MODIFIED, TAPI_CAUSE_RANDOM_ACCESS_FAILURE,
  TAPI_CAUSE_LOWER_LAYER_FAILURE, TAPI_CAUSE_ACCESS_REJECTED, TAPI_CAUSE_REEST_NOT_ALLOWED, TAPI_CAUSE_EMERGENCY_CALL_NOT_ALLOWED,
  TAPI_CAUSE_ACCESS_NOT_ALLOWED, TAPI_CAUSE_RADIO_LINK_FAILURE, TAPI_CAUSE_INVALID_IDENTITY, TAPI_CAUSE_UNKNOWN_IDENTITY,
  TAPI_CAUSE_UNACCEPTABLE_IDENTITY, TAPI_CAUSE_NO_SERVICE_HERE, TAPI_CAUSE_SERVICE_NOT_ALLOWED, TAPI_CAUSE_SERVICE_NOT_AVAIL,
  TAPI_CAUSE_SERVICE_NOT_WORKING, TAPI_CAUSE_CANNOT_IDENTIFY_CALL, TAPI_CAUSE_DEACTIVATION, TAPI_CAUSE_FATAL_ERROR
}
enum  TelCallAnswerType_t { TAPI_CALL_ANSWER_ACCEPT = 0, TAPI_CALL_ANSWER_REJECT = 1 }
enum  TelCallType_t { TAPI_CALL_TYPE_VOICE, TAPI_CALL_TYPE_DATA, TAPI_CALL_TYPE_E911 }
enum  TelCallAlertingPattern_t {
  TAPI_CALL_ALERTING_PATTERN_1 = 0x00, TAPI_CALL_ALERTING_PATTERN_2 = 0x01, TAPI_CALL_ALERTING_PATTERN_3 = 0x02, TAPI_CALL_ALERTING_PATTERN_4 = 0x03,
  TAPI_CALL_ALERTING_PATTERN_5 = 0x04, TAPI_CALL_ALERTING_PATTERN_6 = 0x05, TAPI_CALL_ALERTING_PATTERN_7 = 0x06, TAPI_CALL_ALERTING_PATTERN_8 = 0x07,
  TAPI_CALL_NO_ALERTING_PATTERN = 0x08
}
enum  TelCallActiveState_t { TAPI_CALL_CONNECT_IDLE, TAPI_CALL_CONNECT_ACTIVE, TAPI_CALL_CONNECT_HELD }
enum  TelCallIdentityMode_t { TAPI_CALL_IDENTITY_DEFAULT, TAPI_CALL_IDENTITY_SHOW, TAPI_CALL_IDENTITY_HIDE }
enum  TelCallCugOptions_t { TAPI_CALL_CUG_NO_INFO = 0x00, TAPI_CALL_CUG_SUPRESS_OA, TAPI_CALL_CUG_SUPRESS_PRF_CUG, TAPI_CALL_CUG_SUPRESS_OA_AND_CUG }
enum  TelCallUusType_t { TAPI_CALL_UUS_NONE, TAPI_CALL_UUS_1 }
enum  TelCallUusProtocolType_t {
  TAPI_CALL_UUS_PROTO_SPECIFIC = 0, TAPI_CALL_UUS_PROTO_OSI_HIGHER_LAYER = 1, TAPI_CALL_UUS_PROTO_IA5_CHARS = 4, TAPI_CALL_UUS_PROTO_V120 = 7,
  TAPI_CALL_UUS_PROTO_Q931 = 8
}
enum  TelCallNameMode_t { TAPI_CALL_NAME_AVAIL = 0, TAPI_CALL_NAME_RESTRICTED = 1, TAPI_CALL_NAME_UNAVAIL = 2, TAPI_CALL_NAME_AVAIL_RESTRICTED = 3 }

Define Documentation

#define TAPI_CALL_UUS_DATA_LEN_MAX   131

The Maximum length of the user to user signaling data string.

#define TAPI_CALLING_NAME_SIZE_MAX   80

The maximum length of the string for calling party name.

Enumeration Type Documentation

enum TelCallActiveState_t

State of the current call.

Enumerator:
TAPI_CALL_CONNECT_IDLE  Call is in Idle state.
TAPI_CALL_CONNECT_ACTIVE  Call is in Active state.
TAPI_CALL_CONNECT_HELD  Call is in Held state.

enum TelCallAlertingPattern_t

This enumeration defines the different alerting patterns available.

Enumerator:
TAPI_CALL_ALERTING_PATTERN_1  Pattern 1
TAPI_CALL_ALERTING_PATTERN_2  Pattern 2
TAPI_CALL_ALERTING_PATTERN_3  Pattern 3
TAPI_CALL_ALERTING_PATTERN_4  Pattern 4
TAPI_CALL_ALERTING_PATTERN_5  Pattern 5
TAPI_CALL_ALERTING_PATTERN_6  Pattern 6
TAPI_CALL_ALERTING_PATTERN_7  Pattern 7
TAPI_CALL_ALERTING_PATTERN_8  Pattern 8
TAPI_CALL_NO_ALERTING_PATTERN  No Alerting Pattern

enum TelCallAnswerType_t

Answer type used as in parameter in the answer call API.

Enumerator:
TAPI_CALL_ANSWER_ACCEPT  Used to answer an incoming call when there are no current active calls.
TAPI_CALL_ANSWER_REJECT  Used to reject the incoming call

enum TelCallCause_t

This structure defines the values for Call Cause.

Enumerator:
TAPI_CAUSE_SUCCESS  Success
TAPI_CAUSE_ACCESSDISCARD  Access discarded
TAPI_CAUSE_BARR_BYOPERATOR  Barred by operator
TAPI_CAUSE_BEARERMODE_NOTIMPL  Bearer mode not implemented
TAPI_CAUSE_BEARERMODE_RESTRICTED  Bearer mode restricted
TAPI_CAUSE_BEARERMODE_UNAUTH  Bearer mode un authorized
TAPI_CAUSE_BEARERMODE_UNAVAIL  Bearer mode not available
TAPI_CAUSE_BUSY  (Network/Server) busy
TAPI_CAUSE_CALLMETER_EXPIRED  Call meter expired
TAPI_CAUSE_CALLNO_ERROR  Call number error
TAPI_CAUSE_CKTUNAVAIL  Circuit channel unavailable
TAPI_CAUSE_CONGESTION  Congestion happened
TAPI_CAUSE_NO_CIRCUIT_AVAIL  Circuit not available
TAPI_CAUSE_DESTIN_INCOMPAT  Destination incompatibility
TAPI_CAUSE_DTMF_NOSPEECH  No speech in DTMF
TAPI_CAUSE_DTMF_REJECTED  DTMF rejected
TAPI_CAUSE_FACILITY_NOTIMPL  Facility not implemented
TAPI_CAUSE_FACILITY_NOTSUBSCRIBED  Facility not subscribed
TAPI_CAUSE_INCOMINGCUGCALLS_BARRED  Incoming CUG Calls barred
TAPI_CAUSE_INVALNUM  Invalid number
TAPI_CAUSE_MPTY_ERROR  Multiparty error
TAPI_CAUSE_NOANSWER  No answer
TAPI_CAUSE_NONCUGMEMBER  Non CUG member
TAPI_CAUSE_NUMBERCHANGED  Number changed
TAPI_CAUSE_NUMBER_ERROR  Number error
TAPI_CAUSE_NWFAILURE  Network failure
TAPI_CAUSE_OPERATIONUNAVAIL  Operation not available
TAPI_CAUSE_OUTOFORDER  Out of order
TAPI_CAUSE_PROTOCOL_ERROR  Protocol error
TAPI_CAUSE_QOSUNAVAIL  QOS unavailable
TAPI_CAUSE_REJECT  Rejected
TAPI_CAUSE_REJ_FAIL  Rejection failed
TAPI_CAUSE_REJ_SRVC_NOT_AVL  Rejection service not available
TAPI_CAUSE_REMOTE_CKTUNAVAIL  Remote Circuit channel unavailable
TAPI_CAUSE_RESOURCEUNAVAIL  Resource not available
TAPI_CAUSE_SERVICEID_ERROR  Service id error
TAPI_CAUSE_SERVICE_NOTIMPL  Service not implemented
TAPI_CAUSE_SERVICE_UNAVAIL  Service not available
TAPI_CAUSE_MODIFY_SAME_BEARER  Modify same bearer
TAPI_CAUSE_MODIFY_NOT_PERMITTED  Modification not permitted
TAPI_CAUSE_HOLD_FAIL  Call hold fail
TAPI_CAUSE_TEMPFAILURE  Temporary failure
TAPI_CAUSE_WRONGNUM  Wrong number
TAPI_CAUSE_NORMAL_UNSPECIFIED  Normal but unspecified
TAPI_CAUSE_SSERRINVALIDTIVALUE  SS invalid Transaction ID Value
TAPI_CAUSE_SSERRINVALIDTI  SS Invalid transaction ID
TAPI_CAUSE_SSINCOMPATIBLESTATE  SS incompatible state
TAPI_CAUSE_SSERRSYNTAXERROR  SS syntax error
TAPI_CAUSE_SSPROTOCOLERROR  Protocol error
TAPI_CAUSE_SSNEGATIVEPASSWORDCHECK  Negative password check
TAPI_CAUSE_SSSENTASPHASE1  SS sent as phase1 message
TAPI_CAUSE_SSERROR  Supplementary service error
TAPI_CAUSE_SS_USSD_BUSY  Second USSD request will be rejected when already USSD transaction is ongoing.
TAPI_CAUSE_IDLE  Idle
TAPI_CAUSE_NETWORK_SPECIFIC  Network specific error
TAPI_CAUSE_FADE  voice call was dropped e.g. because of a loss of signal
TAPI_CAUSE_UNKNOWN  unknown no details available
TAPI_CAUSE_INCOM_CALL  terminated by incoming call
TAPI_CAUSE_ALERT_STOP  terminated by alert stop
TAPI_CAUSE_INTERCEPT  voice call was dropped by interception
TAPI_CAUSE_REORDER  voice call was dropped by reordering
TAPI_CAUSE_CLIENT_END  client ended the call
TAPI_CAUSE_ACCESS_CLASS_BLOCKED  access class blocked
TAPI_CAUSE_MEMCAPEXCEEDED  Memory capacity exceeded
TAPI_CAUSE_TYPENOTSUPPORTED  Type not supported
TAPI_CAUSE_REPLACENOTSUPPORTED  Replace not supported
TAPI_CAUSE_PROTOCOLID_ERROR  Protocol id error
TAPI_CAUSE_CLASSNOTSUPPORTED  Class not supported
TAPI_CAUSE_DATACODING_ERROR  Data coding error
TAPI_CAUSE_INVAL_MSG  Invalid message
TAPI_CAUSE_CALL_BARRED  Call barred
TAPI_CAUSE_SIM_CALL_CONTROL_CHANGED_TO_SS  Sim call control changed to SS
TAPI_CAUSE_SIM_CALL_CONTROL_CHANGED_TO_CALL  SIM Call control changed to call
TAPI_CAUSE_SIM_ERROR  SIM error
TAPI_CAUSE_SIM_CALL_CONTROL_MODIFIED  SIM call control modified
TAPI_CAUSE_RANDOM_ACCESS_FAILURE  Random access error
TAPI_CAUSE_LOWER_LAYER_FAILURE  Lower layer error
TAPI_CAUSE_ACCESS_REJECTED  Access rejected
TAPI_CAUSE_REEST_NOT_ALLOWED  Reset not allowed
TAPI_CAUSE_EMERGENCY_CALL_NOT_ALLOWED  Emergency call not allowed
TAPI_CAUSE_ACCESS_NOT_ALLOWED  Access not allowed
TAPI_CAUSE_RADIO_LINK_FAILURE  Radio link failure
TAPI_CAUSE_INVALID_IDENTITY  Invalid identity
TAPI_CAUSE_UNKNOWN_IDENTITY  Unknown identity
TAPI_CAUSE_UNACCEPTABLE_IDENTITY  Un acceptable identity
TAPI_CAUSE_NO_SERVICE_HERE  No service here
TAPI_CAUSE_SERVICE_NOT_ALLOWED  Service not allowed
TAPI_CAUSE_SERVICE_NOT_AVAIL  Service not available
TAPI_CAUSE_SERVICE_NOT_WORKING  Service not working
TAPI_CAUSE_CANNOT_IDENTIFY_CALL  Cannot identify the call
TAPI_CAUSE_DEACTIVATION  Deactivation
TAPI_CAUSE_FATAL_ERROR  Fatal error

enum TelCallCugOptions_t

This enumeration defines the closed user group options

Enumerator:
TAPI_CALL_CUG_NO_INFO  No information
TAPI_CALL_CUG_SUPRESS_OA  suppress OA
TAPI_CALL_CUG_SUPRESS_PRF_CUG  suppress preferential CUG
TAPI_CALL_CUG_SUPRESS_OA_AND_CUG  suppress OA and preferential CUG

enum TelCallIdentityMode_t

This enumeration defines the identity mode option for a call

Enumerator:
TAPI_CALL_IDENTITY_DEFAULT  Calling line identity will be sent. Based on network setting, Line identity will presented to the called party.
TAPI_CALL_IDENTITY_SHOW  Display calling line identity
TAPI_CALL_IDENTITY_HIDE  Hide the display of Calling line identity

enum TelCallNameMode_t

This enumeration defines the call name mode

Enumerator:
TAPI_CALL_NAME_AVAIL  This identifier refers to the presentation of the calling party's name identity to the called party.
TAPI_CALL_NAME_RESTRICTED  This identifier refers to the restriction of presentation of the name identity of the calling party to the called party.
TAPI_CALL_NAME_UNAVAIL  This identifier refers to the unavailability of the calling party's name identity to be offered to the called party.
TAPI_CALL_NAME_AVAIL_RESTRICTED  This identifier refers to the calling party's name identity to be offered to the called party with which presentation restriction is overridden.

enum TelCallType_t

Applications needs to use this call type while using the setip call API. Like the requested call is a voice call or video call.

Enumerator:
TAPI_CALL_TYPE_VOICE  Voice call type.
TAPI_CALL_TYPE_DATA  Data call type - (for modem, fax, packet, etc. calls).
TAPI_CALL_TYPE_E911  Emergency call type.

enum TelCallUusProtocolType_t

This enumeration defines the tapi call uus protocol types

Enumerator:
TAPI_CALL_UUS_PROTO_SPECIFIC  The user information is structured according to user needs.
TAPI_CALL_UUS_PROTO_OSI_HIGHER_LAYER  OSI high layer protocols
TAPI_CALL_UUS_PROTO_IA5_CHARS  user information consists of IA5 characters
TAPI_CALL_UUS_PROTO_V120  rate adaptation
TAPI_CALL_UUS_PROTO_Q931  user-network call control messages

enum TelCallUusType_t

This enumeration defines the UUS Type

Enumerator:
TAPI_CALL_UUS_NONE  No User to User information
TAPI_CALL_UUS_1  User to User information 1

Generated on Mon Mar 31 01:01:00 2008 by  doxygen 1.5.4