SS DataStructures


Files

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

Data Structures

struct  TelSsForwardInfo_t
struct  TelSsUssdMsgInfo_t
struct  TelSsCallBarringInfo_t
struct  TelSsCliRecord_t
struct  TelSsCallBarringRecord_t
struct  TelSsForwardRecord_t
struct  TelSsCallWaitingRecord_t
union  TelSsRecord_t
struct  TelSsInfo_t
struct  TelSsCapabilityInfo_t

Defines

#define TAPI_SS_GSM_BARR_PW_LEN_MAX   4
#define TAPI_CALL_DIALDIGIT_LEN_MAX   82
#define TAPI_SS_USSD_DATA_SIZE_MAX   201

Enumerations

enum  TelSsForwardWhen_t {
  TAPI_SS_FORWARD_WHEN_UNCONDITIONAL_EV, TAPI_SS_FORWARD_WHEN_BUSY_EV, TAPI_SS_FORWARD_WHEN_NO_ANSWER_EV, TAPI_SS_FORWARD_WHEN_NOT_REACHABLE_EV,
  TAPI_SS_FORWARD_WHEN_ALL_FORWARDING_EV
}
enum  TelSsCallBarType_t {
  TAPI_CALL_BARRING_ALL, TAPI_CALL_BARRING_OUTGOING, TAPI_CALL_BARRING_ALL_OUTGOING_CALLS, TAPI_CALL_BARRING_ALL_OUTGOING_INTERN_CALL,
  TAPI_CALL_BARRING_ALL_OUTGOING_INTERN_CALL_EXCEPT, TAPI_CALL_BARRING_INCOMING, TAPI_CALL_BARRING_ALL_INCOMING_CALLS, TAPI_CALL_BARRING_ALL_INCOMING_CALLS_ROAMING,
  TAPI_CALL_BARRING_ALL_INCOMING_CALLS_INSIM
}
enum  TelSsTeleService_t {
  TAPI_SS_TS_ALL_TELE_AND_BEARER_SERVICES, TAPI_SS_TS_ALL_TELESERVICES, TAPI_SS_TS_ALL_SPEECH, TAPI_SS_TS_ALL_DATA_TELESERVICES,
  TAPI_SS_TS_FACS, TAPI_SS_TS_ALL_TELESERVICES_EXCEPT_SMS, TAPI_SS_TS_ALL_PLMN_SPEC_TELE, TAPI_SS_TS_PLMN_SPEC_TELE_1,
  TAPI_SS_TS_PLMN_SPEC_TELE_2, TAPI_SS_TS_PLMN_SPEC_TELE_3, TAPI_SS_TS_PLMN_SPEC_TELE_4, TAPI_SS_TS_PLMN_SPEC_TELE_5,
  TAPI_SS_TS_PLMN_SPEC_TELE_6, TAPI_SS_TS_PLMN_SPEC_TELE_7, TAPI_SS_TS_PLMN_SPEC_TELE_8, TAPI_SS_TS_PLMN_SPEC_TELE_9,
  TAPI_SS_TS_PLMN_SPEC_TELE_A, TAPI_SS_TS_PLMN_SPEC_TELE_B, TAPI_SS_TS_PLMN_SPEC_TELE_C, TAPI_SS_TS_PLMN_SPEC_TELE_D,
  TAPI_SS_TS_PLMN_SPEC_TELE_E, TAPI_SS_TS_PLMN_SPEC_TELE_F, TAPI_SS_TS_PLMN_SPEC_TELE_, TAPI_SS_BS_ALL_BEARER_SERVICES,
  TAPI_SS_BS_ALL_DATA_CDS, TAPI_SS_BS_ALL_ASYNCHRONOUS, TAPI_SS_BS_ALL_SYNCHRONOUS, TAPI_SS_BS_DATA_CIRCUIT_SYNC,
  TAPI_SS_BS_DATA_CIRCUIT_ASYNC, TAPI_SS_BS_DATA_ALL_PDS, TAPI_SS_BS_ALL_DATA_PADCA, TAPI_SS_BS_ALL_PLMN_SPEC_BS,
  TAPI_SS_BS_PLMN_SPEC_TELE_1, TAPI_SS_BS_PLMN_SPEC_TELE_2, TAPI_SS_BS_PLMN_SPEC_TELE_3, TAPI_SS_BS_PLMN_SPEC_TELE_4,
  TAPI_SS_BS_PLMN_SPEC_TELE_5, TAPI_SS_BS_PLMN_SPEC_TELE_6, TAPI_SS_BS_PLMN_SPEC_TELE_7, TAPI_SS_BS_PLMN_SPEC_TELE_8,
  TAPI_SS_BS_PLMN_SPEC_TELE_9, TAPI_SS_BS_PLMN_SPEC_TELE_A, TAPI_SS_BS_PLMN_SPEC_TELE_B, TAPI_SS_BS_PLMN_SPEC_TELE_C,
  TAPI_SS_BS_PLMN_SPEC_TELE_D, TAPI_SS_BS_PLMN_SPEC_TELE_E, TAPI_SS_BS_PLMN_SPEC_TELE_F, TAPI_SS_TS_ALL_DATA,
  TAPI_SS_TS_DATA_CIRCUIT_SYNC, TAPI_SS_TS_MULTIPLE, TAPI_SS_TS_TELEPHONY, TAPI_SS_TS_DATA_CIRCUIT_ASYNC,
  TAPI_SS_TS_DATA_PACKET
}
enum  TelSsUssdRespType_t { TAPI_USSD_RES_UNKNOWN_ALPHABET, TAPI_USSD_RES_DISPL_BUSY, TAPI_USSD_RES_OK, TAPI_USSD_RES_NONE }
enum  TelSsUssdIndType_t {
  TAPI_USSD_IND_NOTIFY = 0x00, TAPI_USSD_IND_NO_ACTION_REQUIRE = 0x01, TAPI_USSD_IND_ACTION_REQUIRE = 0x02, TAPI_USSD_IND_TERMINATED_BY_NET = 0x03,
  TAPI_USSD_IND_OTHER_CLIENT = 0x04, TAPI_USSD_IND_NOT_SUPPORT = 0x05, TAPI_USSD_IND_TIME_OUT = 0x06
}
enum  TelSsCallBarOperationMode_t { TAPI_SS_CALL_BAR_ACTIVATE, TAPI_SS_CALL_BAR_DEACTIVATE }
enum  TelSsCallType_t {
  TAPI_CALL_TYPE_VOICE_EV, TAPI_CALL_TYPE_DATA_EV, TAPI_CALL_TYPE_FAX_EV, TAPI_CALL_TYPE_SHORT_MESS_EV,
  TAPI_CALL_TYPE_DATA_CIRCUIT_SYNC_EV
}
enum  TelSsForwardMode_t { TAPI_CALL_FORWARD_MODE_DISABLE_EV, TAPI_CALL_FORWARD_MODE_ENABLE_EV, TAPI_CALL_FORWARD_MODE_REGISTRATION_EV, TAPI_CALL_FORWARD_MODE_ERASURE_EV }
enum  TelSsForwardType_t { TAPI_CS_FORWARD_TYPE_VOICE_EV = 0, TAPI_CS_FORWARD_TYPE_DATA_EV, TAPI_CS_FORWARD_TYPE_FAX_EV }
enum  TelSsRestrictIDStatus_t { TAPI_CALL_RESTRICT_ID_DEPEND_NETWORK_EV, TAPI_CALL_RESTRICT_ID_ENABLE_EV, TAPI_CALL_RESTRICT_ID_DISABLE_EV }
enum  TelSsType_t {
  TAPI_SS_TYPE_BARRING, TAPI_SS_TYPE_FORWARDING, TAPI_SS_TYPE_WAITING, TAPI_SS_TYPE_IDENTIFICATION,
  TAPI_SS_TYPE_CNAP, TYPE_SS_TYPE_USSD
}
enum  TelSsCause_t {
  TAPI_SS_SUCCESS, TAPI_SS_TIMEREXPIRE, TAPI_SS_UNKNOWNSUBSCRIBER, TAPI_SS_SERVICENOTPROVISIONED,
  TAPI_SS_CALLBARRED, TAPI_SS_ILLEGALSSOPERATION_ERROR, TAPI_SS_NOTAVAILABLE, TAPI_SS_SUBSCRIPTIONVIOLATION,
  TAPI_SS_FACILITYNOTSUPPORTED, TAPI_SS_UNEXPECTEDDATAVALUE, TAPI_SS_PWREGISTRATIONFAILURE, TAPI_SS_NEGATIVEPWCHECK,
  TAPI_SS_NUMBEROFPWATTEMPTSVIOLATION, TAPI_SS_UNKNOWNALPHABET, TAPI_SS_USSDBUSY, TAPI_SS_REJECTEDBYUSER,
  TAPI_SS_REJECTEDBYNETWORK, TAPI_SS_INVALIDDEFLECTEDTONUMBER, TAPI_SS_MAXNOMPTYEXCEEDED, TAPI_SS_RESOURCESNOTAVAILABLE,
  TAPI_SS_UNKNOWNERROR, TAPI_SS_OEM_NOT_SUPPORTED
}
enum  TelSsStatus_t {
  TAPI_SS_STATUS_ACTIVE, TAPI_SS_STATUS_REGISTERED, TAPI_SS_STATUS_PROVISIONED, TAPI_SS_STATUS_QUIESCENT,
  TAPI_SS_STATUS_NOTHING
}
enum  TelSsLineIdentificationType_t {
  TAPI_CALLING_LINE_IDENTITY_PRESENTATION, TAPI_CALLING_LINE_IDENTITY_RESTRICTION, TAPI_CONNECTED_LINE_IDENTITY_PRESENTATION, TAPI_CONNECTED_LINE_IDENTITY_RESTRICTION,
  TAPI_CALLED_LINE_IDENTITY_PRESENTATION, TAPI_CALLING_NAME_PRESENTATION
}
enum  TelSsCliStatus_t {
  TAPI_CLI_STATUS_NOT_PROVISONED, TAPI_CLI_STATUS_PROVISIONED, TAPI_CLI_STATUS_ACTIVATED, TAPI_CLI_STATUS_UNKOWN,
  TAPI_CLI_STATUS_TEMP_RESTRICTED, TAPI_CLI_STATUS_TEMP_ALLOWED
}
enum  TelSsBarPwdType_t { TAPI_SS_BAR_GET_PWD, TAPI_SS_BAR_NEW_PWD, TAPI_SS_BAR_VERIFY_NEW_PWD }

Define Documentation

#define TAPI_CALL_DIALDIGIT_LEN_MAX   82

maximum length of dial digit

#define TAPI_SS_GSM_BARR_PW_LEN_MAX   4

maximum length of barring password

#define TAPI_SS_USSD_DATA_SIZE_MAX   201

User-to-user data maximum size


Enumeration Type Documentation

This enumeration defines the Bar password type.

Enumerator:
TAPI_SS_BAR_GET_PWD  This password type indicates already set barring password
TAPI_SS_BAR_NEW_PWD  This password type indicates new password
TAPI_SS_BAR_VERIFY_NEW_PWD  This password type indicates verifying new password

This enumeration defines the call barring operation mode .

Enumerator:
TAPI_SS_CALL_BAR_ACTIVATE  Activate call barring
TAPI_SS_CALL_BAR_DEACTIVATE  De Activate call barring

The various types of call barring. Note, only one type of incoming barring and only one type of outgoing barring may be active at any time.

Enumerator:
TAPI_CALL_BARRING_ALL  Barring all outgoing and incoming calls
TAPI_CALL_BARRING_OUTGOING  Barring outgoing call
TAPI_CALL_BARRING_ALL_OUTGOING_CALLS  Barring all outgoing calls
TAPI_CALL_BARRING_ALL_OUTGOING_INTERN_CALL  Barring all outgoing international calls
TAPI_CALL_BARRING_ALL_OUTGOING_INTERN_CALL_EXCEPT  Barring all international outgoing
TAPI_CALL_BARRING_INCOMING  Barring the incoming call
TAPI_CALL_BARRING_ALL_INCOMING_CALLS  Barring all incoming calls
TAPI_CALL_BARRING_ALL_INCOMING_CALLS_ROAMING  Barring all incoming calls while roaming
TAPI_CALL_BARRING_ALL_INCOMING_CALLS_INSIM  Barring Incoming Calls from numbers which is not stored in the SIM memory

This enumeration defines the call type .

Enumerator:
TAPI_CALL_TYPE_VOICE_EV  Voice Call
TAPI_CALL_TYPE_DATA_EV  Data Call
TAPI_CALL_TYPE_FAX_EV  Fax Call
TAPI_CALL_TYPE_SHORT_MESS_EV  Short Message
TAPI_CALL_TYPE_DATA_CIRCUIT_SYNC_EV  Data Circuit Sync

Describes whether a supplementary service request was a success or a failure; and if it failed, why.

Enumerator:
TAPI_SS_SUCCESS  SS operation was successful
TAPI_SS_TIMEREXPIRE  SS operation timer expired on network.
TAPI_SS_UNKNOWNSUBSCRIBER  SS error indicating unknown/illegal subscriber.
TAPI_SS_SERVICENOTPROVISIONED  SS service not provisioned
TAPI_SS_CALLBARRED  SS operation barred.
TAPI_SS_ILLEGALSSOPERATION_ERROR  Illegal SS operation
TAPI_SS_NOTAVAILABLE  SS not available in network
TAPI_SS_SUBSCRIPTIONVIOLATION  SS service subscription violation.
TAPI_SS_FACILITYNOTSUPPORTED  SS service facility not supported
TAPI_SS_UNEXPECTEDDATAVALUE  SS error indicating unexpected data value on network side
TAPI_SS_PWREGISTRATIONFAILURE  SS error indicating change password failure.
TAPI_SS_NEGATIVEPWCHECK  SS error indicating negative password check.
TAPI_SS_NUMBEROFPWATTEMPTSVIOLATION  SS error indicating barring password attempts violated.
TAPI_SS_UNKNOWNALPHABET  SS error indicating unknown SS data coding of alphabet
TAPI_SS_USSDBUSY  SS error indicating USSD Busy(Already ss / ussd is ongoing).
TAPI_SS_REJECTEDBYUSER  SS operation rejected by user.
TAPI_SS_REJECTEDBYNETWORK  SS operation rejected by network.
TAPI_SS_INVALIDDEFLECTEDTONUMBER  SS error indicating the invalid deflected to number.
TAPI_SS_MAXNOMPTYEXCEEDED  SS error indicating Maximum mpty is reached.
TAPI_SS_RESOURCESNOTAVAILABLE  SS error indicating resources not available in network.
TAPI_SS_UNKNOWNERROR  SS error indicating unknown error
TAPI_SS_OEM_NOT_SUPPORTED  If oem do not support any of SS requests, then this error will be returned back

This enumeration defines the cli service status .

Enumerator:
TAPI_CLI_STATUS_NOT_PROVISONED  Service not provided by the service provider
TAPI_CLI_STATUS_PROVISIONED  Service is provided by the service provider
TAPI_CLI_STATUS_ACTIVATED  Service is activated at the network
TAPI_CLI_STATUS_UNKOWN  Service status is unknown
TAPI_CLI_STATUS_TEMP_RESTRICTED  Service is temporarily restricted
TAPI_CLI_STATUS_TEMP_ALLOWED  Service is temporarily allowed

This enumeration defines the forward mode .

Enumerator:
TAPI_CALL_FORWARD_MODE_DISABLE_EV  Deactivate call forwarding
TAPI_CALL_FORWARD_MODE_ENABLE_EV  Activate call forwarding
TAPI_CALL_FORWARD_MODE_REGISTRATION_EV  Register Call forwarding
TAPI_CALL_FORWARD_MODE_ERASURE_EV  De-register call forwarding

This enumeration defines the forward type .

Enumerator:
TAPI_CS_FORWARD_TYPE_VOICE_EV  Voice call forward
TAPI_CS_FORWARD_TYPE_DATA_EV  Data call forward
TAPI_CS_FORWARD_TYPE_FAX_EV  Fax call forward

/** This enumeration defines the call forwarding flavor.

Enumerator:
TAPI_SS_FORWARD_WHEN_UNCONDITIONAL_EV  Unconditional
TAPI_SS_FORWARD_WHEN_BUSY_EV  When Busy
TAPI_SS_FORWARD_WHEN_NO_ANSWER_EV  When No Reply
TAPI_SS_FORWARD_WHEN_NOT_REACHABLE_EV  When Not Reachable
TAPI_SS_FORWARD_WHEN_ALL_FORWARDING_EV  Forward All Calls

These are the four types of identity presentation / restriction services.

Enumerator:
TAPI_CALLING_LINE_IDENTITY_PRESENTATION  identify the party calling this phone
TAPI_CALLING_LINE_IDENTITY_RESTRICTION  hide the identity of this phone when calling others
TAPI_CONNECTED_LINE_IDENTITY_PRESENTATION  identify the party to whom the calling party (this phone) is connected
TAPI_CONNECTED_LINE_IDENTITY_RESTRICTION  restrict yourself from being identified by incoming calls, such as forwarded calls
TAPI_CALLED_LINE_IDENTITY_PRESENTATION  Called line identity presentation
TAPI_CALLING_NAME_PRESENTATION  Calling Name Presentation

This enumeration defines the types of restrict identification .

Enumerator:
TAPI_CALL_RESTRICT_ID_DEPEND_NETWORK_EV  Depend on Network
TAPI_CALL_RESTRICT_ID_ENABLE_EV  Enable Restricted Call Id
TAPI_CALL_RESTRICT_ID_DISABLE_EV  Disable Restricted Call Id

The status of a supplementary service feature (e.g. Call Forwarding or Call Barring).
These enumerated values should be used as masks

Enumerator:
TAPI_SS_STATUS_ACTIVE  Active Status
TAPI_SS_STATUS_REGISTERED  SS Registered
TAPI_SS_STATUS_PROVISIONED  Provision established
TAPI_SS_STATUS_QUIESCENT  Provision established
TAPI_SS_STATUS_NOTHING  Status Nothing

The types of telecommunication services are used for setting the statuses of supplementary services. They are typically not supported in IS-2000 or IS-136. See GSM 02.30 Annex C and GSM 22.030 Annex C.

Enumerator:
TAPI_SS_TS_ALL_TELE_AND_BEARER_SERVICES  All Teleservices & Bearer Services
TAPI_SS_TS_ALL_TELESERVICES  All Teleservices
TAPI_SS_TS_ALL_SPEECH  All Speech Services
TAPI_SS_TS_ALL_DATA_TELESERVICES  All Data Teleservices
TAPI_SS_TS_FACS  All Fax Service
TAPI_SS_TS_ALL_TELESERVICES_EXCEPT_SMS  All teleservice except SMS
TAPI_SS_TS_ALL_PLMN_SPEC_TELE  PLMN specific teleservices
TAPI_SS_TS_PLMN_SPEC_TELE_1  PLMN specific teleservice 1
TAPI_SS_TS_PLMN_SPEC_TELE_2  PLMN specific teleservice 2
TAPI_SS_TS_PLMN_SPEC_TELE_3  PLMN specific teleservice 3
TAPI_SS_TS_PLMN_SPEC_TELE_4  PLMN specific teleservice 4
TAPI_SS_TS_PLMN_SPEC_TELE_5  PLMN specific teleservice 5
TAPI_SS_TS_PLMN_SPEC_TELE_6  PLMN specific teleservice 6
TAPI_SS_TS_PLMN_SPEC_TELE_7  PLMN specific teleservice 7
TAPI_SS_TS_PLMN_SPEC_TELE_8  PLMN specific teleservice 8
TAPI_SS_TS_PLMN_SPEC_TELE_9  PLMN specific teleservice 9
TAPI_SS_TS_PLMN_SPEC_TELE_A  PLMN specific teleservice 10
TAPI_SS_TS_PLMN_SPEC_TELE_B  PLMN specific teleservice 11
TAPI_SS_TS_PLMN_SPEC_TELE_C  PLMN specific teleservice 12
TAPI_SS_TS_PLMN_SPEC_TELE_D  PLMN specific teleservice 13
TAPI_SS_TS_PLMN_SPEC_TELE_E  PLMN specific teleservice 14
TAPI_SS_TS_PLMN_SPEC_TELE_F  PLMN specific teleservice 15
TAPI_SS_BS_ALL_BEARER_SERVICES  All PLMN specific bearer services
TAPI_SS_BS_ALL_DATA_CDS  All Data CDS
TAPI_SS_BS_ALL_ASYNCHRONOUS  All Asynchronous
TAPI_SS_BS_ALL_SYNCHRONOUS  All Synchronous
TAPI_SS_BS_DATA_CIRCUIT_SYNC  All Data Circuit Synchronous
TAPI_SS_BS_DATA_CIRCUIT_ASYNC  All Data Circuit Asynchronous
TAPI_SS_BS_DATA_ALL_PDS  All Data PDS
TAPI_SS_BS_ALL_DATA_PADCA  All Data PADCA
TAPI_SS_BS_ALL_PLMN_SPEC_BS  All PLMN Spec BS
TAPI_SS_BS_PLMN_SPEC_TELE_1  PLMN specific bearer service 1
TAPI_SS_BS_PLMN_SPEC_TELE_2  PLMN specific bearer service 2
TAPI_SS_BS_PLMN_SPEC_TELE_3  PLMN specific bearer service 3
TAPI_SS_BS_PLMN_SPEC_TELE_4  PLMN specific bearer service 4
TAPI_SS_BS_PLMN_SPEC_TELE_5  PLMN specific bearer service 5
TAPI_SS_BS_PLMN_SPEC_TELE_6  PLMN specific bearer service 6
TAPI_SS_BS_PLMN_SPEC_TELE_7  PLMN specific bearer service 7
TAPI_SS_BS_PLMN_SPEC_TELE_8  PLMN specific bearer service 8
TAPI_SS_BS_PLMN_SPEC_TELE_9  PLMN specific bearer service 9
TAPI_SS_BS_PLMN_SPEC_TELE_A  PLMN specific bearer service 10
TAPI_SS_BS_PLMN_SPEC_TELE_B  PLMN specific bearer service 11
TAPI_SS_BS_PLMN_SPEC_TELE_C  PLMN specific bearer service 12
TAPI_SS_BS_PLMN_SPEC_TELE_D  PLMN specific bearer service 13
TAPI_SS_BS_PLMN_SPEC_TELE_E  PLMN specific bearer service 14
TAPI_SS_BS_PLMN_SPEC_TELE_F  PLMN specific bearer service 15
TAPI_SS_TS_ALL_DATA  All Data
TAPI_SS_TS_DATA_CIRCUIT_SYNC  Data Circuit Sync
TAPI_SS_TS_MULTIPLE  multiple
TAPI_SS_TS_TELEPHONY  Telephony
TAPI_SS_TS_DATA_CIRCUIT_ASYNC  Data Circuit Async
TAPI_SS_TS_DATA_PACKET  Data packet

This enumeration type defines the Supplementary service types

Enumerator:
TAPI_SS_TYPE_BARRING  Barring SS
TAPI_SS_TYPE_FORWARDING  Forward SS
TAPI_SS_TYPE_WAITING  Waiting SS
TAPI_SS_TYPE_IDENTIFICATION  Identification SS
TAPI_SS_TYPE_CNAP  CNAP SS
TYPE_SS_TYPE_USSD  Unstructured supplementary data SS

This enumeration defines the ussd Indication Type

Enumerator:
TAPI_USSD_IND_NOTIFY  notify : to display ussd data to user
TAPI_USSD_IND_NO_ACTION_REQUIRE  No further user action required
TAPI_USSD_IND_ACTION_REQUIRE  Further user action required
TAPI_USSD_IND_TERMINATED_BY_NET  0x03 : USSD terminated by network
TAPI_USSD_IND_OTHER_CLIENT  0x04 : other local client has responded
TAPI_USSD_IND_NOT_SUPPORT  0x05 : operation not supported
TAPI_USSD_IND_TIME_OUT  0x06 : Time out when there is no response from network

This enumeration defines the ussd response type

Enumerator:
TAPI_USSD_RES_UNKNOWN_ALPHABET  USSD data is unknown
TAPI_USSD_RES_DISPL_BUSY  USSD Data response is display busy
TAPI_USSD_RES_OK  USSD Data is encoded and properly propagated
TAPI_USSD_RES_NONE  NO USSD Response from client


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