qaGobiApiSms.h File Reference
Short Message Service API function prototypes.
More...
Go to the source code of this file.
Data Structures |
struct | slqssendsmsparams_s |
struct | BroadcastConfig |
struct | _qaQmi3GPPBroadcastCfgInfo |
struct | CDMABroadcastConfig |
struct | _qaQmi3GPP2BroadcastCfgInfo |
struct | cdmaMsgEncodingParams |
struct | cdmaMsgDecodingParams |
struct | wcdmaMsgEncodingParams |
struct | wcdmaMsgDecodingParams |
struct | _transLayerinfo |
struct | _getTransLayerInfoResp |
struct | _getTransNWRegInfoResp |
struct | _getIndicationRegResp |
struct | _setIndicationRegReq |
struct | smsMsgprotocolResp |
struct | smsMaxStorageSizeReq |
struct | smsMaxStorageSizeResp |
Defines |
#define | CONFIG_LEN 0x05 |
#define | TIME_STAMP_BUF 0x08 |
#define | ABSOLUTE_VALIDITY 0x08 |
#define | TIME_DATE_BUF 0x09 |
Typedefs |
typedef struct
_qaQmi3GPPBroadcastCfgInfo | qaQmi3GPPBroadcastCfgInfo |
typedef struct
_qaQmi3GPP2BroadcastCfgInfo | qaQmi3GPP2BroadcastCfgInfo |
typedef struct _transLayerinfo | transLayerInfo |
typedef struct
_getTransLayerInfoResp | getTransLayerInfoResp |
typedef struct
_getTransNWRegInfoResp | getTransNWRegInfoResp |
typedef struct
_getIndicationRegResp | getIndicationRegResp |
typedef struct _setIndicationRegReq | setIndicationRegReq |
Functions |
ULONG | SLQSDeleteSMS (ULONG storageType, ULONG *pMessageIndex, ULONG *pMessageTag, BYTE *pMessageMode) |
ULONG | SLQSGetSMS (ULONG storageType, ULONG messageIndex, ULONG *pMessageTag, ULONG *pMessageFormat, ULONG *pMessageSize, BYTE *pMessage, BYTE *pMessageMode) |
ULONG | SendSMS (ULONG messageFormat, ULONG messageSize, BYTE *pMessage, ULONG *pMessageFailureCode) |
ULONG | SLQSSendSMS (slqssendsmsparams_s *pSendSmsParams) |
ULONG | GetSMSCAddress (BYTE addressSize, CHAR *pSMSCAddress, BYTE typeSize, CHAR *pSMSCType) |
ULONG | SetSMSCAddress (CHAR *pSMSCAddress, CHAR *pSMSCType) |
ULONG | SaveSMS (ULONG storageType, ULONG messageFormat, ULONG messageSize, BYTE *pMessage, ULONG *pMessageIndex) |
ULONG | SLQSGetSMSList (ULONG storageType, ULONG *pRequestedTag, ULONG *pMessageListSize, BYTE *pMessageList, BYTE *pMessageMode) |
ULONG | SLQSModifySMSStatus (ULONG storageType, ULONG messageIndex, ULONG messageTag, BYTE *pMessageMode) |
ULONG | SLQSGetSmsBroadcastConfig (BYTE mode, qaQmi3GPPBroadcastCfgInfo *pBroadcastConfig, qaQmi3GPP2BroadcastCfgInfo *pCDMABroadcastConfig) |
ULONG | SLQSSetSmsBroadcastConfig (BYTE mode, qaQmi3GPPBroadcastCfgInfo *pBroadcastConfig, qaQmi3GPP2BroadcastCfgInfo *pCDMABroadcastConfig) |
ULONG | SLQSSetSmsBroadcastActivation (BYTE mode, BYTE broadcastActivate) |
ULONG | SLQSCDMAEncodeMOTextMsg (struct cdmaMsgEncodingParams *pCdmaMsgEncodingParams) |
ULONG | SLQSCDMADecodeMTTextMsg (struct cdmaMsgDecodingParams *pCdmaMsgDecodingParams) |
ULONG | SLQSWCDMAEncodeMOTextMsg (struct wcdmaMsgEncodingParams *pWcdmaMsgEncodingParams) |
ULONG | SLQSWCDMADecodeMTTextMsg (struct wcdmaMsgDecodingParams *pWcdmaMsgDecodingParams) |
ULONG | SLQSGetTransLayerInfo (getTransLayerInfoResp *pGetTransLayerInfoResp) |
ULONG | SLQSGetTransNWRegInfo (getTransNWRegInfoResp *pGetTransNWRegInfoResp) |
ULONG | SLQSGetIndicationRegister (getIndicationRegResp *pGetIndicationRegInfo) |
ULONG | SLQSSetIndicationRegister (setIndicationRegReq *pSetIndicationRegReq) |
ULONG | SLQSSmsGetMessageProtocol (smsMsgprotocolResp *pMessageProtocol) |
ULONG | SLQSSmsGetMaxStorageSize (smsMaxStorageSizeReq *pMaxStorageSizeReq, smsMaxStorageSizeResp *pMaxStorageSizeResp) |
Detailed Description
Short Message Service API function prototypes.
Copyright: © 2011 Sierra Wireless, Inc. all rights reserved
Define Documentation
#define ABSOLUTE_VALIDITY 0x08 |
#define TIME_DATE_BUF 0x09 |
#define TIME_STAMP_BUF 0x08 |
Typedef Documentation
This structure contains Get Indication Register Response parameters
- Parameters:
-
| pRegTransLayerInfoEvt | -
- Optional 1 BYTE parameter indicating registration status of transport layer information events
- Values:
- 0x00 - Disabled
- 0x01 - Enabled
- function SLQSGetIndicationRegister() returns a default value 0xFF if this parameter is allocated memory in the structure and no response is received from the device.
|
| pRegTransNWRegInfoEvt | -
- Optional 1 BYTEparameter indicating registration status of transport network registration information events
- Values:
- 0x00 - Disabled
- 0x01 - Enabled
- function SLQSGetIndicationRegister() returns a default value 0xFF if this parameter is allocated memory in the structure and no response is received from the device.
|
| pRegCallStatInfoEvt | -
- Optional 1 BYTE parameter indicating registration status of call status information events
- Values:
- 0x00 - Disabled
- 0x01 - Enabled
- function SLQSGetIndicationRegister() returns a default value 0xFF if this parameter is allocated memory in the structure and no response is received from the device.
|
This structure contains Get Transport Layer Info Response parameters
- Parameters:
-
| pRegInd | -
- Optional parameter indicating if transport layer is registered
- Values:
- 0x00 - Transport layer is not registered
- 0x01 - Transport layer is registered
- function SLQSGetTransLayerInfo() returns a default value 0xFF if no response is received from the device.
|
| pTransLayerInfo |
- Pointer to structure of transLayerInfo.
- function SLQSGetTransLayerInfo() returns a default value 0xFF for parameter values if no response is received from the device.
|
This structure contains transport network registration info parameter
- Parameters:
-
| pRegStatus | -
- Optional 1 BYTE parameter indicating transport layer network registration status
- Values:
- 0x00 - No service
- 0x01 - In progress
- 0x02 - Failed
- 0x03 - Limited Service
- 0x04 - Full Service
- function SLQSGetTransNWRegInfo() returns a default value 0xFF if no response is received from the device.
|
This structure contains the 3GPP2 Broadcast Configuration Information parameters
- Parameters:
-
| activated_ind |
- Broadcast SMS
- 0x00 - Deactivated
- 0x01 - Activated
|
| num_instances |
- Number of sets (N) of parameters Following each set describes one entry in the broadcast configuration table.
- serviceCategory
- language
- selected
|
| broadcastConfig |
|
This structure contains the 3GPP Broadcast Configuration Information parameters
- Parameters:
-
| activated_ind |
- Broadcast SMS
- 0x00 - Deactivated
- 0x01 - Activated
|
| num_instances |
- Number of sets (N) of parameters Following each set describes one entry in the broadcast configuration table.
- fromServiceId
- toServiceId
- selected
|
| broadcastConfig |
|
This structure contains Indication Register request parameters
- Parameters:
-
| pRegTransLayerInfoEvt | -
- Optional 1 BYTE parameter indicating registration status of transport layer information events
- Values:
- 0x00 - Disabled
- 0x01 - Enabled
- NULL - No change - specifying NULL indicates that the device will continue to use the existing setting (disable/enable) which has been previously set for the device
|
| pRegTransNWRegInfoEvt | -
- Optional 1 BYTE parameter indicating registration status of transport network registration information events
- Values:
- 0x00 - Disabled
- 0x01 - Enabled
- NULL - No change - specifying NULL indicates that the device will continue to use the existing setting (disable/enable) which has been previously set for the device
|
| pRegCallStatInfoEvt | -
- Optional 1 BYTE parameter indicating registration status of call status information events
- Values:
- 0x00 - Disabled
- 0x01 - Enabled
- NULL - No change - specifying NULL indicates that the device will continue to use the existing setting (disable/enable) which has been previously set for the device
|
This structure contains Transport Layer Information
- Parameters:
-
| TransType |
|
| TransCap |
- Transport Capability
- Values:
|
Function Documentation
Gets the SMS center address.
- Parameters:
-
| addressSize |
- The maximum number of characters (including NULL terminator) that the SMS center address array can contain.
|
| pSMSCAddress[0UT] |
- The SMS center address represented as a NULL terminated string.
|
| typeSize |
- The maximum number of characters (including NULL terminator) that the SMS center address type array can contain.
|
| pSMSCType[0UT] |
- The SMS center address type represented as a NULL terminated string.
|
- Returns:
- eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
- See also:
- See qmerrno.h for eQCWWAN_xxx error values
- Note:
- Technology Supported: ALL
Device Supported: MC83x5, MC7700
Timeout: 2 seconds
Saves an SMS message to device memory
- Parameters:
-
| storageType |
- SMS message storage type
- 0 - UIM - Invalid in case of CDMA device that does not require SIM
- 1 - NV
|
| messageFormat |
- Message format
- 0 - CDMA (IS-637B)
- 1 - 5 (Reserved)
- 6 - GSM/WCDMA PP
|
| messageSize |
- The length of the message contents in bytes
|
| pMessage[IN] |
|
| pMessageIndex[OUT] |
- The message index assigned by the device
|
- Returns:
- eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
- See also:
- See qmerrno.h for eQCWWAN_xxx error values
- Note:
- Technology Supported: ALL
Device Supported: MC83x5, MC7700/50
Timeout: 10 seconds
Sends an SMS message for immediate over-the-air transmission
- Parameters:
-
| messageFormat |
- Message format
- 0 - CDMA (IS-637B)
- 1 - 5 (Reserved)
- 6 - GSM/WCDMA PP
|
| messageSize |
- The length of the message contents in bytes
|
| pMessage[IN] |
|
| pMessageFailureCode[OUT] |
- pointer to message failure code. If cause code is not provided, then value will be 0xFFFFFFFF
|
- Returns:
- eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
- See also:
- See qmerrno.h for eQCWWAN_xxx error values
- Note:
- Technology Supported: ALL
Device Supported: MC83x5, MC7700/50
Timeout: 5 minutes
Sets the SMS center address.
- Parameters:
-
| pSMSCAddress[IN] |
- The SMS center address represented as a NULL terminated string
|
| pSMSCType[IN] |
- The SMS center address type represented as a NULL terminated string (optional).
|
- Returns:
- eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
- See also:
- See qmerrno.h for eQCWWAN_xxx error values
- Note:
- Technology Supported: ALL
Device Supported: MC83x5, MC7700
Timeout: 5 seconds
Decodes text message to CDMA PDU message
- Parameters:
-
| pMsgToBeEncodedCDMA[IN/OUT] |
- Pointer to structure containing parameters needed for decoding
|
- Returns:
- eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
- See also:
- see qmerrno.h for eQCWWAN_xxx error values
- Note:
- Technology Supported: CDMA
Device Supported: MC83x5, MC7750
Timeout: None
Encodes text message to CDMA PDU message.
- Parameters:
-
| pMsgToBeEncodedCDMA[IN/OUT] |
- SLQS Runtime Settings Information
|
- Returns:
- eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
- See also:
- see qmerrno.h for eQCWWAN_xxx error values
- Note:
- Technology Supported: CDMA
Device Supported: MC83x5, MC7750
Timeout: None
Deletes one or more SMSs from device memory. If both of the optional parameters, messageIndex and messageTag, are NULL, all messages are deleted from the storage location specified in the mandatory storageType parameter. The optional index and tag parameters narrow the range of messages being deleted. If an index is specified, the single message with the index from the specified memory store will be deleted. If a tag is specified, all messages in the specified memory store whose tag matches that specified will be deleted.
There are three ways to use this message:
- Specify storageType only
- Deletes all messages from memory storage
- Specify storageType and a tag
- Deletes all messages from memory storage that match the given message tag
- Specify storageType and an index
- Deletes only the message with the given index from memory storage
- Parameters:
-
| storageType |
- SMS message storage type
- 0 - UIM - Invalid in case of CDMA device that does not require SIM
- 1 - NV
|
| pMessageIndex[IN] |
|
| pMessageTag[IN] |
- (Optional) message tag
- 0 - Read
- 1 - Not read
- 2 - Mobile originated and sent
- 3 - Mobile originated but not yet sent
|
| pMessageMode[IN] |
- 0x00 - CDMA, LTE (if network type is CDMA)
- 0x01 - GW, LTE (if network type is UMTS)
|
- Returns:
- eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
- See also:
- See qmerrno.h for eQCWWAN_xxx error values
- Note:
- Technology Supported: ALL
Device Supported: MC83x5, MC7700/50
Timeout: 10 seconds
This API provides registration state of different WMS indications.
- Parameters:
-
| pGetIndicationRegInfo | [OUT]
- Pointer to structure of getIndicationRegResp
|
- Returns:
- eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
- See also:
- See qmerrno.h for eQCWWAN_xxx error values
- Note:
- Technology Supported: UMTS/CDMA
Device Supported: MC7700/10/50
Timeout: 2 Secs
Returns an SMS from device memory.
- Parameters:
-
| storageType |
- SMS message storage type
- 0 - UIM - Invalid in case of CDMA device that does not require SIM
- 1 - NV
|
| messageIndex |
|
| pMessageTag[OUT] |
- Message tag
- 0 - Read
- 1 - Not read
- 2 - Mobile originated and sent
- 3 - Mobile originated but not yet sent
|
| pMessageFormat[OUT] |
- Message format
- 0 - CDMA (IS-637B)
- 1 - 5 (Reserved)
- 6 - GSM/WCDMA PP
|
| pMessageSize[IN/OUT] |
- Upon input the maximum number of bytes that can be written to the message array.
- Upon successful output the actual number of bytes written to the message array.
|
| pMessage[OUT] |
- The message contents array
|
| pMessageMode[IN] |
- 0x00 - CDMA, LTE (if network type is CDMA)
- 0x01 - GW, LTE (if network type is UMTS)
|
- Returns:
- eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
- See also:
- See qmerrno.h for eQCWWAN_xxx error values
- Note:
- Technology Supported: ALL
Device Supported: MC83x5, MC7700/50
Timeout: 5 seconds
Provides Information about the SMS BroadcastConfiguration
- Parameters:
-
| mode |
- Mode
- 0x00 - CDMA, LTE (if network type is CDMA)
- 0x01 - GW, LTE (if network type is UMTS)
|
| pBroadcastConfig[OUT] |
- The data for 3GPP Broadcast Information.
|
| pCDMABroadcastConfig[OUT] |
- The data for 3GPP2 Broadcast Information.
|
- Returns:
- eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
- See also:
- See qmerrno.h for eQCWWAN_xxx error values
- Note:
- Technology Supported: ALL
Device Supported: None
Timeout: 5 seconds
Returns the list of SMS messages stored on the device.
- Parameters:
-
| storageType |
- SMS message storage type
- 0 - UIM - Invalid in case of CDMA device that does not require SIM
- 1 - NV
|
| pRequestedTag[IN] |
- (Optional) Message tag
- 0 - Read
- 1 - Not read
- 2 - Mobile originated and sent
- 3 - Mobile originated but not yet sent
|
| pMessageListSize[IN/OUT] |
- Upon input the maximum number of elements that the message list array can contain.
- Upon successful output the actual number of elements in the message list array.
|
| pMessageList[OUT] |
|
| pMessageMode[IN] |
- 0x00 - CDMA, LTE (if network type is CDMA)
- 0x01 - GW, LTE (if network type is UMTS)
|
- Returns:
- eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
- See also:
- See qmerrno.h for eQCWWAN_xxx error values
- Note:
- Technology Supported: ALL
Device Supported: MC83x5, MC7700/50
Timeout: 5 seconds
This API provides information about the transport layer.
- Parameters:
-
| pGetTransLayerInfoResp | [OUT]
- Pointer to structure of getTransLayerInfoResp
|
- Returns:
- eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
- See also:
- See qmerrno.h for eQCWWAN_xxx error values
- Note:
- Technology Supported: UMTS/CDMA
Device Supported: MC7700/10/50
Timeout: 2 Secs
This API provides transport layer network registration info.
- Parameters:
-
| pGetTransNWRegInfoResp | [OUT]
- Pointer to structure of getTransNWRegInfoResp
|
- Returns:
- eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
- See also:
- See qmerrno.h for eQCWWAN_xxx error values
- Note:
- Technology Supported: UMTS/CDMAn
Device Supported: MC7700/10/50
Timeout: 2 Secs
Modifies the status of an SMS message saved in storage on the device.
- Parameters:
-
| storageType |
- SMS message storage type
- 0 - UIM - Invalid in case of CDMA device that does not require SIM
- 1 - NV
|
| messageIndex |
|
| messageTag |
|
| pMessageMode[IN] |
- 0x00 - CDMA, LTE (if network type is CDMA)
- 0x01 - GW, LTE (if network type is UMTS)
|
- Returns:
- eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
- See also:
- See qmerrno.h for eQCWWAN_xxx error values
- Note:
- Technology Supported: ALL
Device Supported: MC83x5, MC7700/50
Timeout: 5 seconds
Sends an SMS message for immediate over-the-air transmission
- Parameters:
-
- Returns:
- eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
- See also:
- See qmerrno.h for eQCWWAN_xxx error values
- Note:
- Technology Supported: ALL
Device Supported: MC83x5, MC7700/10/50
Timeout: 10 seconds
This API sets the registration state of different SMS indications.
- Parameters:
-
| pSetIndicationRegReq | [IN]
- Pointer to structure of indicationRegReqParams
|
- Returns:
- eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
- See also:
- See qmerrno.h for eQCWWAN_xxx error values
- Note:
- Technology Supported: UMTS/CDMA
Device Supported: MC7700/10/50
Timeout: 2 Secs
ULONG SLQSSetSmsBroadcastActivation |
( |
BYTE |
mode, |
|
|
BYTE |
broadcastActivate | |
|
) |
| | |
Enables or disables the reception of broadcast SMS messages.
- Parameters:
-
| Mode |
- Mode
- 0x00 - CDMA, LTE (if network type is CDMA)
- 0x01 - GW, LTE (if network type is UMTS)
|
| broadcastActivate |
- 0x00 - Disable broadcast
- 0x01 - Activate broadcast
|
- Returns:
- eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
- See also:
- See qmerrno.h for eQCWWAN_xxx error values
- Note:
- Technology Supported: ALL
Device Supported: None
Timeout: 5 seconds
Sets the information about the SMS BroadcastConfiguration
- Parameters:
-
| mode |
- Mode
- 0x00 - CDMA, LTE (if network type is CDMA)
- 0x01 - GW, LTE (if network type is UMTS)
|
| pBroadcastConfig[IN] |
- The data for 3GPP Broadcast Information.
|
| pCDMABroadcastConfig[IN] |
- The data for 3GPP2 Broadcast Information.
|
- Returns:
- eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
- See also:
- See qmerrno.h for eQCWWAN_xxx error values
- Note:
- Technology Supported: ALL
Device Supported: None
Timeout: 5 seconds
This API provides the maximum number of messages that can be stored in the specified memory storage. Also it provides the number of slots currently available
- Parameters:
-
| pMaxStorageSizeReq[IN] |
- Request parameters for SmsSLQSGetMaxStorageSize
|
| pMaxStorageSizeResp[OUT] |
- Response parameters for SmsSLQSGetMaxStorageSize
|
- Returns:
- eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
- See also:
- See qmerrno.h for eQCWWAN_xxx error values
- Note:
- Technology Supported: UMTS/CDMA/LTE
Device Supported: MC8355, MC7700, MC7750 & SL9090
Timeout: 2 Secs
This API queries the message protocol currently in use for the WMS client.
- Parameters:
-
- Returns:
- eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
- See also:
- See qmerrno.h for eQCWWAN_xxx error values
- Note:
- Technology Supported: UMTS/CDMA/LTE
Device Supported: MC83x5, MC7700/10/50, SL9090
Timeout: 2 Secs
Decodes WCDMA PDU message, returns stucture filled with decoded parameters
- Parameters:
-
| pwcdmaMsgDecodingParams[IN/OUT] |
- Pointer to paramters required for decoding
|
- Returns:
- eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
- See also:
- see qmerrno.h for eQCWWAN_xxx error values
- Note:
- Technology Supported: UMTS
Device Supported: MC83x5, MC7700/10
Timeout: none
Returns the encoded WCDMA PDU message.
- Parameters:
-
| pwcdmaMsgEncodingParams[IN/OUT] |
- Pointer to parameters Required for encoding
|
- Returns:
- eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
- See also:
- see qmerrno.h for eQCWWAN_xxx error values
- Note:
- Technology Supported: UMTS
Device Supported: MC83x5, MC7700/10
Timeout: None