qaGobiApiVoice.h

Go to the documentation of this file.

/*
 * Copyright: © 2011-2015 Sierra Wireless, Inc. all rights reserved
 */
#ifndef __GOBI_API_VOICE_H__
#define __GOBI_API_VOICE_H__

#ifdef __cplusplus
extern "C" {
#endif

#define MAXUSSDLENGTH          182
#define MAX_CALL_NO_LEN        81
#define MAX_DESCRIPTION_LENGTH 255
#define PASSWORD_LENGTH        4
#define MAX_NO_OF_CALLS        20

struct USSInfo
{
    BYTE ussDCS;
    BYTE ussLen;
    BYTE ussData[MAXUSSDLENGTH];
};

ULONG OriginateUSSD(
    BYTE  *pInfo );

ULONG AnswerUSSD(
    BYTE  *pInfo );

ULONG CancelUSSD();

typedef struct
{
    BYTE UUSType;
    BYTE UUSDcs;
    BYTE UUSDatalen;
    BYTE UUSData[MAX_DESCRIPTION_LENGTH];
} UUSInfo;

typedef struct
{
    WORD CUGIndex;
    BYTE SuppPrefCUG;
    BYTE SuppOA;
} CUGInfo;

typedef struct
{
    BYTE extBit;
    BYTE subAddrType;
    BYTE oddEvenInd;
    BYTE subAddrLen;
    BYTE subAddr[MAX_DESCRIPTION_LENGTH];
} calledPartySubAdd;

typedef struct
{
    BYTE              callNumber[MAX_CALL_NO_LEN];
    BYTE              *pCallType;
    BYTE              *pCLIRType;
    UUSInfo           *pUUSInFo;
    CUGInfo           *pCUGInfo;
    BYTE              *pEmergencyCategory;
    calledPartySubAdd *pCallPartySubAdd;
    ULONG             *pSvcType;
} voiceCallRequestParams;

typedef struct
{
   BYTE alphaDcs;
   BYTE alphaLen;
   BYTE alphaText[MAX_DESCRIPTION_LENGTH];
} alphaIDInfo;

typedef struct
{
   BYTE svcType;
   BYTE reason;
} ccSUPSType;

typedef struct
{
    BYTE        *pCallID;
    alphaIDInfo *pAlphaIDInfo;
    BYTE        *pCCResultType;
    ccSUPSType  *pCCSUPSType;
} voiceCallResponseParams;

ULONG SLQSVoiceDialCall( voiceCallRequestParams  *pCallRequestParams,
                         voiceCallResponseParams *pCallResponseParams );

ULONG SLQSVoiceEndCall(
    BYTE *pCallId );

enum serviceClassInformation
{
    VOICE_SUPS_SRV_CLASS_NONE             = 0x00,
    VOICE_SUPS_SRV_CLASS_VOICE            = 0x01,
    VOICE_SUPS_SRV_CLASS_DATA             = 0x02,
    VOICE_SUPS_SRV_CLASS_FAX              = 0x04,
    VOICE_SUPS_SRV_CLASS_SMS              = 0x08,
    VOICE_SUPS_SRV_CLASS_DATACIRCUITSYNC  = 0x10,
    VOICE_SUPS_SRV_CLASS_DATACIRCUITASYNC = 0x20,
    VOICE_SUPS_SRV_CLASS_PACKETACCESS     = 0x40,
    VOICE_SUPS_SRV_CLASS_PADACCESS        = 0x80,
};

typedef struct
{
    BYTE numberType;
    BYTE numberPlan;
} callFwdTypeAndPlan;

typedef struct
{
    BYTE voiceSvc;
    BYTE reason;
    BYTE *pServiceClass;
    BYTE *pCallBarringPasswd;
    BYTE *pCallForwardingNumber;
    BYTE *pTimerVal;
    callFwdTypeAndPlan *pCallFwdTypeAndPlan;
} voiceSetSUPSServiceReq;

typedef struct
{
    WORD        *pFailCause;
    alphaIDInfo *pAlphaIDInfo;
    BYTE        *pCCResultType;
    BYTE        *pCallID;
    ccSUPSType  *pCCSUPSType;
} voiceSetSUPSServiceResp;

ULONG SLQSVoiceSetSUPSService (
    voiceSetSUPSServiceReq  *pVoiceSetSUPSServiceReq,
    voiceSetSUPSServiceResp *pVoiceSetSUPSServiceResp );

typedef struct
{
    BYTE  namID;
    ULONG airTimerValue;
} airTimer;

typedef struct
{
    BYTE  namID;
    ULONG roamTimerValue;
} roamTimer;

typedef struct
{
    BYTE namID;
    BYTE evrcCapability;
    WORD homePageVoiceSO;
    WORD homeOrigVoiceSO;
    WORD roamOrigVoiceSO;
} prefVoiceSO;

typedef struct
{
    BYTE        *pAutoAnswer;
    airTimer    *pAirTimerConfig;
    roamTimer   *pRoamTimerConfig;
    BYTE        *pTTYMode;
    prefVoiceSO *pPrefVoiceSO;
    BYTE        *pPrefVoiceDomain;
} voiceSetConfigReq;

typedef struct
{
    BYTE *pAutoAnsStatus;
    BYTE *pAirTimerStatus;
    BYTE *pRoamTimerStatus;
    BYTE *pTTYConfigStatus;
    BYTE *pPrefVoiceSOStatus;
    BYTE *pVoiceDomainPrefStatus;
} voiceSetConfigResp;

ULONG SLQSVoiceSetConfig (
        voiceSetConfigReq  *pVoiceSetConfigReq,
        voiceSetConfigResp *pVoiceSetConfigResp );

typedef struct
{
    BYTE *pCallId;
} voiceAnswerCall;

ULONG SLQSVoiceAnswerCall(
    voiceAnswerCall *pVoiceAnswerCall );

typedef struct
{
    BYTE ActiveStatus;
    BYTE ProvisionStatus;
} CLIRResp;

typedef struct
{
   CLIRResp    *pCLIRResp;
   WORD        *pFailCause;
   alphaIDInfo *pAlphaIDInfo;
   BYTE        *pCCResType;
   BYTE        *pCallID;
   ccSUPSType  *pCCSUPSType;
} voiceGetCLIRResp;

ULONG SLQSVoiceGetCLIR( voiceGetCLIRResp  *pVoiceGetCLIRResp );

typedef struct
{
    BYTE ActiveStatus;
    BYTE ProvisionStatus;
} CLIPResp;

typedef struct
{
   CLIPResp    *pCLIPResp;
   WORD        *pFailCause;
   alphaIDInfo *pAlphaIDInfo;
   BYTE        *pCCResType;
   BYTE        *pCallID;
   ccSUPSType  *pCCSUPSType;
} voiceGetCLIPResp;

ULONG SLQSVoiceGetCLIP( voiceGetCLIPResp *pVoiceGetCLIPResp );

typedef struct
{
   BYTE        *pSvcClass;
   WORD        *pFailCause;
   alphaIDInfo *pAlphaIDInfo;
   BYTE        *pCCResType;
   BYTE        *pCallID;
   ccSUPSType  *pCCSUPSType;
} voiceGetCallWaitInfo;

ULONG SLQSVoiceGetCallWaiting( voiceGetCallWaitInfo *pVoiceGetCallWaitInfo );

typedef struct
{
   BYTE reason;
   BYTE *pSvcClass;
} voiceGetCallBarringReq;

typedef struct
{
    BYTE        *pSvcClass;
    WORD        *pFailCause;
    alphaIDInfo *pAlphaIDInfo;
    BYTE        *pCCResType;
    BYTE        *pCallID;
    ccSUPSType  *pCCSUPSType;
} voiceGetCallBarringResp;

ULONG SLQSVoiceGetCallBarring( voiceGetCallBarringReq  *pVoiceGetCallBarringReq,
                               voiceGetCallBarringResp *pVoiceGetCallBarringResp );

typedef struct
{
    BYTE Reason;
    BYTE *pSvcClass;
} voiceGetCallFWReq;

typedef struct
{
    BYTE SvcStatus;
    BYTE SvcClass;
    BYTE numLen;
    BYTE number[255];
    BYTE noReplyTimer;
} callFWInfo;

typedef struct
{
    BYTE SvcStatus;
    BYTE SvcClass;
    BYTE noReplyTimer;
    BYTE PI;
    BYTE SI;
    BYTE numType;
    BYTE numPlan;
    BYTE numLen;
    BYTE number[255];
} callFWExtInfo;

typedef struct
{
    BYTE       numInstances;
    callFWInfo CallFWInfo[MAX_NO_OF_CALLS];
} getCallFWInfo;

typedef struct
{
    BYTE          numInstances;
    callFWExtInfo CallFWExtInfo[MAX_NO_OF_CALLS];
} getCallFWExtInfo;

typedef struct
{
    getCallFWInfo    *pGetCallFWInfo;
    WORD             *pFailCause;
    alphaIDInfo      *pAlphaIDInfo;
    BYTE             *pCCResType;
    BYTE             *pCallID;
    ccSUPSType       *pCCSUPSType;
    getCallFWExtInfo *pGetCallFWExtInfo;
} voiceGetCallFWResp;

ULONG SLQSVoiceGetCallForwardingStatus( voiceGetCallFWReq  *pVoiceGetCallFWReq,
                                        voiceGetCallFWResp *pVoiceGetCallFWResp );

typedef struct
{
    BYTE Reason;
    BYTE oldPasswd[PASSWORD_LENGTH];
    BYTE newPasswd[PASSWORD_LENGTH];
    BYTE newPasswdAgain[PASSWORD_LENGTH];
} voiceSetCallBarringPwdInfo;

typedef struct
{
    WORD        *pFailCause;
    alphaIDInfo *pAlphaIDInfo;
    BYTE        *pCCResType;
    BYTE        *pCallID;
    ccSUPSType  *pCCSUPSType;
} voiceSetCallBarringPwdResp;

ULONG SLQSVoiceSetCallBarringPassword(
        voiceSetCallBarringPwdInfo *pVoiceSetCallBarringPwdInfo,
        voiceSetCallBarringPwdResp *pSetCallBarringPwdResp );

typedef struct
{
    BYTE callID;
    BYTE callState;
    BYTE callType;
    BYTE direction;
    BYTE mode;
} callInfo;

typedef struct
{
    BYTE presentationInd;
    BYTE numLen;
    BYTE remPartyNumber[MAX_CALL_NO_LEN];
} remotePartyNum;

typedef struct
{
    BYTE namePI;
    BYTE codingScheme;
    BYTE nameLen;
    BYTE callerName[MAX_DESCRIPTION_LENGTH];
} remotePartyName;

typedef struct
{
    BYTE numPresInd;
    BYTE screeningInd;
    BYTE numType;
    BYTE numPlan;
    BYTE callerIDLen;
    BYTE callerID[MAX_CALL_NO_LEN];
} connectNumInfo;

typedef struct
{
   BYTE diagInfoLen;
   BYTE diagnosticInfo[MAX_DESCRIPTION_LENGTH];
} diagInfo;

typedef struct
{
    BYTE callID;
} voiceCallInfoReq;

typedef struct
{
    callInfo        *pCallInfo;
    remotePartyNum  *pRemotePartyNum;
    WORD            *pSrvOpt;
    BYTE            *pVoicePrivacy;
    BYTE            *pOTASPStatus;
    remotePartyName *pRemotePartyName;
    UUSInfo         *pUUSInfo;
    BYTE            *pAlertType;
    alphaIDInfo     *pAlphaIDInfo;
    connectNumInfo  *pConnectNumInfo;
    diagInfo        *pDiagInfo;
    ULONG           *pAlertingPattern;
} voiceCallInfoResp;

ULONG SLQSVoiceGetCallInfo( voiceCallInfoReq  *pGetCallInfoReq,
                            voiceCallInfoResp *pGetCallInfoResp );

typedef struct
{
     callInfo Callinfo;
     BYTE     isEmpty;
     BYTE     ALS;
} getAllCallInformation;

typedef struct
{
    BYTE           callID;
    remotePartyNum RemotePartyNum;
} getAllCallRmtPtyNum;

typedef struct
{
    BYTE            callID;
    remotePartyName RemotePartyName;
} getAllCallRmtPtyName;

typedef struct
{
    BYTE    callID;
    UUSInfo uusInfo;
} allCallsUUSInfo;

typedef struct
{
    BYTE        callID;
    alphaIDInfo AlphaIDInfo;
} allCallsAlphaIDInfo;


typedef struct
{
   BYTE     callID;
   diagInfo DiagInfo;
} allCallsDiagInfo;

typedef struct
{
    BYTE callID;
    BYTE numPI;
    BYTE numSI;
    BYTE numType;
    BYTE numPlan;
    BYTE numLen;
    BYTE number[MAX_CALL_NO_LEN];
} peerNumberInfo;

typedef struct
{
    BYTE                  numInstances;
    getAllCallInformation getAllCallInfo[MAX_NO_OF_CALLS];
} arrCallInfo;

typedef struct
{
    BYTE                numInstances;
    getAllCallRmtPtyNum RmtPtyNum[MAX_NO_OF_CALLS];
} arrRemotePartyNum;

typedef struct
{
    BYTE                 numInstances;
    getAllCallRmtPtyName GetAllCallRmtPtyName[MAX_NO_OF_CALLS];
} arrRemotePartyName;

typedef struct
{
    BYTE numInstances;
    BYTE callID[MAX_NO_OF_CALLS];
    BYTE AlertingType[MAX_NO_OF_CALLS];
} arrAlertingType;

typedef struct
{
    BYTE            numInstances;
    allCallsUUSInfo AllCallsUUSInfo[MAX_NO_OF_CALLS];
} arrUUSInfo;

typedef struct
{
  BYTE numInstances;
  BYTE callID[MAX_NO_OF_CALLS];
  WORD srvOption[MAX_NO_OF_CALLS];
} arrSvcOption;

typedef struct
{
   BYTE numInstances;
   BYTE callID[MAX_NO_OF_CALLS];
   WORD callEndReason[MAX_NO_OF_CALLS];
} arrCallEndReason;

typedef struct
{
    BYTE                numInstances;
    allCallsAlphaIDInfo allCallsAlphaIDInfoArr[MAX_NO_OF_CALLS];
} arrAlphaID;

typedef struct
{
     BYTE           numInstances;
     peerNumberInfo ConnectedPartyNum[MAX_NO_OF_CALLS];
} arrConnectPartyNum;

typedef struct
{
    BYTE             numInstances;
    allCallsDiagInfo DiagInfo[MAX_NO_OF_CALLS];
} arrDiagInfo;

typedef struct
{
     BYTE           numInstances;
     peerNumberInfo CalledPartyNum[MAX_NO_OF_CALLS];
} arrCalledPartyNum;

typedef struct
{
    BYTE           numInstances;
    peerNumberInfo RedirPartyNum[MAX_NO_OF_CALLS];
} arrRedirPartyNum;

typedef struct
{
     BYTE  numInstances;
     BYTE  callID[MAX_NO_OF_CALLS];
     ULONG alertingPattern[MAX_NO_OF_CALLS];
} arrAlertingPattern;

typedef struct
{
    arrCallInfo        *pArrCallInfo;
    arrRemotePartyNum  *pArrRemotePartyNum;
    arrRemotePartyName *pArrRemotePartyName;
    arrAlertingType    *pArrAlertingType;
    arrUUSInfo         *pArrUUSInfo;
    arrSvcOption       *pArrSvcOption;
    BYTE               *pOTASPStatus;
    BYTE               *pVoicePrivacy;
    arrCallEndReason   *pArrCallEndReason;
    arrAlphaID         *pArrAlphaID;
    arrConnectPartyNum *pArrConnectPartyNum;
    arrDiagInfo        *pArrDiagInfo;
    arrCalledPartyNum  *pArrCalledPartyNum;
    arrRedirPartyNum   *pArrRedirPartyNum;
    arrAlertingPattern *pArrAlertingPattern;
} voiceGetAllCallInfo;

ULONG SLQSVoiceGetAllCallInfo( voiceGetAllCallInfo *pGetAllCallInfo );

typedef struct
{
    BYTE SUPSType;
    BYTE *pCallID;
}voiceManageCallsReq;

typedef struct
{
    WORD *pFailCause;
}voiceManageCallsResp;

ULONG SLQSVoiceManageCalls (
    voiceManageCallsReq  *pVoiceManageCallsReq,
    voiceManageCallsResp *pVoiceManageCallsResp );

typedef struct
{
    BYTE *pCallID;
    BYTE digitCnt;
    BYTE pDigitBuff[MAX_DESCRIPTION_LENGTH];
}burstDTMFInfo;

typedef struct
{
    BYTE DTMFPulseWidth;
    BYTE DTMFInterdigitInterval;
}DTMFLengths;

typedef struct
{
    burstDTMFInfo BurstDTMFInfo;
    DTMFLengths   *pBurstDTMFLengths;
}voiceBurstDTMFInfo;

ULONG SLQSVoiceBurstDTMF(
    voiceBurstDTMFInfo *pBurstDTMFInfo );

typedef struct
{
    BYTE *pCallID;
    BYTE DTMFdigit;
}voiceContDTMFinfo;

ULONG SLQSVoiceStartContDTMF(
    voiceContDTMFinfo *pContDTMFInfo );

typedef struct
{
    BYTE callID;
}voiceStopContDTMFinfo;

ULONG SLQSVoiceStopContDTMF(
    voiceStopContDTMFinfo *pVoiceStopContDTMFinfo);

typedef struct
{
    BYTE *pCallID;
    BYTE *pFlashPayLd;
    BYTE *pFlashType;
} voiceFlashInfo;

ULONG SLQSVoiceSendFlash ( voiceFlashInfo *pFlashInfo );

typedef struct
{
    BYTE privacyPref;
} voiceSetPrefPrivacy;

ULONG SLQSVoiceSetPreferredPrivacy ( voiceSetPrefPrivacy *pSetPrefPrivacy );

typedef struct
{
    BYTE *pRegDTMFEvents;
    BYTE *pRegVoicePrivacyEvents;
    BYTE *pSuppsNotifEvents;
} voiceIndicationRegisterInfo;

ULONG SLQSVoiceIndicationRegister(
    voiceIndicationRegisterInfo *pVoiceIndicationRegisterInfo );

typedef struct
{
    BYTE callID;
    BYTE DTMFEvent;
    BYTE digitCnt;
    BYTE digitBuff[MAX_DESCRIPTION_LENGTH];
} DTMFInfo;

typedef struct
{
    BYTE svcType;
    BYTE isModByCC;
} SUPSInfo;

typedef struct
{
    BYTE newPwd[PASSWORD_LENGTH];
    BYTE newPwdAgain[PASSWORD_LENGTH];
} newPwdData;

typedef struct
{
    BYTE ActiveStatus;
    BYTE ProvisionStatus;
} COLPResp;

typedef struct
{
    BYTE ActiveStatus;
    BYTE ProvisionStatus;
} COLRResp;

typedef struct
{
    BYTE ActiveStatus;
    BYTE ProvisionStatus;
} CNAPResp;

typedef struct
{
    BYTE *pAutoAnswer;
    BYTE *pAirTimer;
    BYTE *pRoamTimer;
    BYTE *pTTYMode;
    BYTE *pPrefVoiceSO;
    BYTE *pAMRStatus;
    BYTE *pPrefVoicePrivacy;
    BYTE *pNamID;
    BYTE *pVoiceDomainPref;
} voiceGetConfigReq;

typedef struct
{
    BYTE gsmAmrStat;
    BYTE wcdmaAmrStat;
} curAMRConfig;

typedef struct
{
    BYTE         *pAutoAnswerStat;
    airTimer     *pAirTimerCnt;
    roamTimer    *pRoamTimerCnt;
    BYTE         *pCurrTTYMode;
    prefVoiceSO  *pCurPrefVoiceSO;
    curAMRConfig *pCurAMRConfig;
    BYTE         *pCurVoicePrivacyPref;
    BYTE         *pCurVoiceDomainPref;
} voiceGetConfigResp;

ULONG SLQSVoiceGetConfig (
          voiceGetConfigReq  *pVoiceGetConfigReq,
          voiceGetConfigResp *pVoiceGetConfigResp );

typedef struct
{
    struct USSInfo USSInformation;
} voiceOrigUSSDNoWaitInfo;

ULONG SLQSVoiceOrigUSSDNoWait (
          voiceOrigUSSDNoWaitInfo *pVoiceOrigUSSDNoWaitInfo );

typedef struct
{
    BYTE subsType;
} voiceBindSubscriptionInfo;

ULONG SLQSVoiceBindSubscription (
          voiceBindSubscriptionInfo *pVoiceBindSubscriptionInfo );

typedef struct
{
    BYTE switchOption;
} voiceALSSetLineSwitchInfo;

ULONG SLQSVoiceALSSetLineSwitching (
          voiceALSSetLineSwitchInfo *pVoiceALSSetLineSwitchInfo );

typedef struct
{
    BYTE lineValue;
} voiceALSSelectLineInfo;

ULONG SLQSVoiceALSSelectLine (
          voiceALSSelectLineInfo *pVoiceALSSelectLineInfo );

typedef struct
{
    COLPResp     *pCOLPResp;
    WORD         *pFailCause;
    alphaIDInfo  *pAlphaIDInfo;
    BYTE         *pCCResType;
    BYTE         *pCallID;
    ccSUPSType   *pCCSUPSType;
} voiceGetCOLPResp;

ULONG SLQSVoiceGetCOLP(
        voiceGetCOLPResp *pVoiceGetCOLPResp );

typedef struct
{
    COLRResp    *pCOLRResp;
    WORD        *pFailCause;
    alphaIDInfo *pAlphaIDInfo;
    BYTE        *pCCResType;
    BYTE        *pCallID;
    ccSUPSType  *pCCSUPSType;
} voiceGetCOLRResp;

ULONG SLQSVoiceGetCOLR(
        voiceGetCOLRResp *pVoiceGetCOLRResp );

typedef struct
{
    CNAPResp     *pCNAPResp;
    WORD         *pFailCause;
    alphaIDInfo  *pAlphaIDInfo;
    BYTE         *pCCResType;
    BYTE         *pCallID;
    ccSUPSType   *pCCSUPSType;
} voiceGetCNAPResp;

ULONG SLQSVoiceGetCNAP(
        voiceGetCNAPResp *pVoiceGetCNAPResp );

/*
 * This structure contains the parameters of USS response
 *
 * \param pfailureCause
 *
 * \param AlphaIdentifier
 *          - see alphaIDInfo definition
 *
 * \param pUSSDInfo
 *          - USS Data from Network (See structure USSInfo)
 *
 * \param pCcResultType
 *          - CC result code
 *
 * \param pCallId
 *          - Caller ID information
 *
 * \param pCCSuppsType
 *          - See structure 'ccSUPSType' definition
 *
 */
struct USSResp
{
    WORD                          *pfailureCause;
    alphaIDInfo                   *pAlphaIDInfo;
    struct USSInfo                *pUSSDInfo;
    BYTE                          *pCcResultType;
    BYTE                          *pCallId;
    ccSUPSType                    *pCCSuppsType;
};

ULONG SLQSOriginateUSSD(
    struct USSInfo *pReq,
    struct USSResp *pResp);

typedef struct
{
    char *pTypeCode;
    char *pRespData;
}USSDRespFNetwork;
#ifdef __cplusplus
} /* extern "C" { */
#endif

#endif /* __GOBI_API_VOICE_H__ */