展訊短信模塊接口介紹

TITLEMocorMMISMSInterfaceUserGuideVersion:1.0.DocCode:SW-MOCOR-UG-0005Date:200重要聲明版權(quán)聲明本文檔中的任何內(nèi)容受《中華人民共和國著作權(quán)法》的保護，版權(quán)所有?2023，展訊通信，保存所有權(quán)利，但注明引用其他方的內(nèi)容除外。商標聲明展訊通信和展訊通信的產(chǎn)品是展訊通信專有。在提及其他公司及其產(chǎn)品時將使用各自公司所擁有的商標，這種使用的目的僅限于引用。不作保證聲明展訊通信不對此文檔中的任何內(nèi)容作任何明示或暗示的陳述或保證，而且不對特定目的的適銷性及適用性或者任何間接、特殊或連帶的損失承當任何責任。保密聲明本文檔〔包括任何附件〕包含的信息是保密信息。接收人了解其獲得的本文檔是保密的，除用于規(guī)定的目的外不得用于任何目的，也不得將本文檔泄露給任何第三方。前言文檔說明本文檔描述了SMS模塊為其他模塊提供的接口函數(shù)的設(shè)計及使用。閱讀對象本文檔適合SMS模塊的開發(fā)人員使用。內(nèi)容介紹本文檔包括三個章節(jié)，分別為：第一章：概述。簡單介紹了SMS接口模塊的特點及軟件架構(gòu)；第二章：數(shù)據(jù)類型。介紹了SMS接口所涉及到的各種數(shù)據(jù)類型，如枚舉、結(jié)構(gòu)等；第三章：API函數(shù)。詳細描述了SMS接口包含的所有API函數(shù)的定義及相關(guān)說明。文檔約定本文檔采用下面醒目標志來表示在操作過程中應該特別注意的地方。注意：提醒操作中應注意的事項。說明：說明比擬重要的事項。相關(guān)文檔目錄TOC\o"1-3"\h\z\t"標題6,1,標題7,2,標題8,3"第1章概述1-11.1系統(tǒng)概述1-11.2SMS模塊主要實現(xiàn)功能1-11.3SMS模塊在系統(tǒng)中的位置1-1第2章數(shù)據(jù)類型2-12.1常量定義2-12.2枚舉2-12.2.1MMISMS_BOX_TYPE_E2-12.2.2MMISMS_OPERATE_TYPE_E2-22.2.3MMISMS_MSG_TYPE_E2-22.2.4MMISMS_MO_MT_TYPE_E2-32.3結(jié)構(gòu)2-42.3.1MMISMS_BCD_NUMBER_T2-42.3.2MMISMS_ORDER_INFO_T2-5第3章API函數(shù)3-13.1MMIAPISMS_AppInit3-13.2MMIAPISMS_GetDelAllFlag3-13.3MMIAPISMS_WriteNewMessage3-23.4MMIAPISMS_AnswerMessage3-23.5MMIAPISMS_CheckMemHaveEnough3-33.6MMIAPISMS_IsOrderOk3-43.7MMIAPISMS_IsSMSReady3-43.8MMIAPISMS_SendInit3-53.9MMIAPISMS_CheckSMSState3-53.10MMIAPISMS_DelSMSByAT3-63.11MMIAPISMS_OpenSmsBox3-63.12MMIAPISMS_ShowNewMsgPrompt3-73.13MMIAPISMS_OpenMainMenuWin3-73.14MMIAPISMS_OpenFreqWordListForCc3-83.15MMIAPISMS_AppSendSmsForMSD3-83.16MMIAPISMS_RestoreFactorySetting3-93.17MMIAPISMS_DeleteMsgInorder3-103.18MMIAPISMS_InsertOneMsgToOrder3-103.19MIAPISMS_UpdateMsgStatusInOrder3-113.20MMIAPISMS_MMSOrderDone3-11附錄ARevisionHistoryA-1概述系統(tǒng)概述SMS模塊作為短消息的人機界面局部，負責獲取，處理由PS層轉(zhuǎn)發(fā)的有關(guān)短消息的消息以及用戶的各種操作，執(zhí)行相應的動作，并將執(zhí)行結(jié)果反應給PS或者用戶，實現(xiàn)短消息的功能。SMS模塊主要實現(xiàn)功能SMS模塊的主要功能有：接收新短消息：能正確的接收和處理新短消息；寫短消息：用戶可以寫新短消息進行發(fā)送或保存；發(fā)送短消息： 能夠向別的用戶發(fā)送短消息〔支持群發(fā)〕；處理小區(qū)播送：接收用戶設(shè)置的信道和語言的新小區(qū)播送；操作已保存的短消息： 對于保存的短消息進行讀、編輯、刪除、發(fā)送、多種方式排序、標記等操作。SMS模塊在系統(tǒng)中的位置REF_Ref187652165\h圖11描述了SMS模塊在系統(tǒng)中的位置。圖STYLEREF1\s1SEQ圖\*ARABIC\s11SMS模塊在總體結(jié)構(gòu)中的位置數(shù)據(jù)類型常量定義常量名取值說明MMIMESSAGE_DIAPLAY_LEN22短消息列表中每個item所顯示的最大長度枚舉MMISMS_BOX_TYPE_E【含義】MMISMS_BOX_TYPE_E定義了信箱類型。【定義】typedefenum{MMISMS_BOX_NONE,MMISMS_BOX_MT,MMISMS_BOX_SENDSUCC,MMISMS_BOX_SENDFAIL,MMISMS_BOX_NOSEND}MMISMS_BOX_TYPE_E;【參數(shù)說明】參數(shù)名稱含義MMISMS_BOX_NONE沒有信箱類型MMISMS_BOX_MT收件箱MMISMS_BOX_SENDSUCC已發(fā)信箱MMISMS_BOX_SENDFAIL發(fā)件箱MMISMS_BOX_NOSEND草稿箱MMISMS_OPERATE_TYPE_E【含義】MMISMS_OPERATE_TYPE_E定義了當前的操作類型，當開機排序完畢后，根據(jù)當前的操作類型進入相應的信箱或者菜單。【定義】typedefenum{MMISMS_OPERATE_NONE,MMISMS_WRITE_NEW_SMS,MMISMS_OPEN_BOX,MMISMS_VIEW_MEMORY}MMISMS_OPERATE_TYPE_E;【參數(shù)說明】參數(shù)名稱含義MMISMS_OPERATE_NONE當前無操作MMISMS_WRITE_NEW_SMS寫新的短消息MMISMS_OPEN_BOX翻開信箱MMISMS_VIEW_MEMORY查看信息空間MMISMS_MSG_TYPE_E【含義】MMISMS_MSG_TYPE_E定義了信息的類型，包括短消息，彩信、WAPPush消息、WAPOTA消息、彩信OTA消息?！径x】typedefenum{MMISMS_TYPE_SMS=0,MMISMS_TYPE_MMS=1,MMISMS_TYPE_WAP_PUSH=2,MMISMS_TYPE_MMS_OTA=3,MMISMS_TYPE_WAP_OTA=4,MMISMS_TYPE_MAX}MMISMS_MSG_TYPE_E;【參數(shù)說明】參數(shù)名稱含義MMISMS_TYPE_SMS短消息MMISMS_TYPE_MMS彩信MMISMS_TYPE_WAP_PUSHWAPPush消息MMISMS_TYPE_MMS_OTA彩信OTA消息MMISMS_TYPE_WAP_OTAWapOTA消息MMISMS_MO_MT_TYPE_E【含義】MMISMS_MO_MT_TYPE_E定義了信息的狀態(tài)，包括已讀短消息、未讀短消息、已讀狀態(tài)報告、未讀狀態(tài)報告、未下載彩信、未讀彩信、已讀彩信、發(fā)送失敗信息、發(fā)送成功信息、未發(fā)送信息?！径x】typedefenummmisms_mo_mt_type_tag{MMISMS_MT_NOT_DOWNLOAD,MMISMS_MT_TO_BE_READ,MMISMS_MT_HAVE_READ,MMISMS_MT_SR_TO_BE_READ,MMISMS_MT_SR_HAVE_READ,MMISMS_MO_SEND_SUCC,MMISMS_MO_SEND_FAIL,MMISMS_MO_DRAFT,}MMISMS_MO_MT_TYPE_E【參數(shù)說明】參數(shù)名稱含義MMISMS_MT_NOT_DOWNLOAD未下載彩信MMISMS_MT_TO_BE_READ未讀彩信MMISMS_MT_HAVE_READ已讀彩信MMISMS_MT_SR_TO_BE_READ未讀狀態(tài)報告MMISMS_MT_SR_HAVE_READ已讀狀態(tài)報告MMISMS_MO_SEND_SUCC已發(fā)信息MMISMS_MO_SEND_FAIL發(fā)送失敗信息MMISMS_MO_DRAFT未發(fā)送信息【考前須知】當前的消息類型剛好占3位，如果需要添加類型那么需要增加位數(shù)。結(jié)構(gòu)MMISMS_BCD_NUMBER_T【含義】MMISMS_BCD_NUMBER_T定義了短消息的號碼類型【定義】typedefstructtag_MMISMS_BCD_NUMBER_T{uint8number_len;uint8npi_ton;uint8 number[MMISMS_BCD_NUMBER_MAX_LEN];}MMISMS_BCD_NUMBER_T;參數(shù)名稱含義number_lennumber數(shù)組的BYTE個數(shù)npi_ton具體意義請查看GSM04.08number用于存放當前號碼數(shù)組的bufferMMISMS_ORDER_INFO_T【含義】MMISMS_ORDER_INFO_T定義了信息的狀態(tài)、號碼等信息，用于開機排序和列表顯示等?！径x】typedefstruct_MMISMS_ORDER_INFO_T{uint32 time;int32 record_id;MMISMS_MO_MT_TYPE_E mo_mt_type;MMISMS_MSG_TYPE_Emsg_type;MN_DUAL_SYS_E dual_sys;MMISMS_DISPLAY_CONTENT_T display_content;uint8*sender;}MMISMS_ORDER_INFO_T;【參數(shù)說明】參數(shù)名稱含義time時間，單位：秒record_id信息的唯一標識mo_mt_type當前信息的狀態(tài)msg_type信息的類型dual_sy雙卡參數(shù)display_content在列表中顯示的內(nèi)容senderWAPPush、OTA消息的發(fā)件人號碼或者電子郵件地址API函數(shù)MMIAPISMS_AppInit【函數(shù)原型】voidMMIAPISMS_AppInit(void);【函數(shù)功能】短消息模塊初始化。【參數(shù)說明】無。【返回值】無。【考前須知】無。MMIAPISMS_GetDelAllFlag【函數(shù)原型】BOOLEANMMISMS_GetDelAllFlag(void);【函數(shù)功能】判斷當前是否正在刪除信息,如果正在刪除信息,定時關(guān)機等操作將延遲到信息刪除完畢后執(zhí)行?！緟?shù)說明】無?！痉祷刂怠縏RUE：當前正在刪除信息；FALSE：當前沒有刪除信息操作。【考前須知】無。MMIAPISMS_WriteNewMessage【函數(shù)原型】voidMMIAPISMS_WriteNewMessage(MN_DUAL_SYS_Edual_sys,MMI_STRING_T*sms_init_ptr,uint8*dest_addr_ptr,uint8dest_addr_len);【函數(shù)功能】根據(jù)雙卡參數(shù)、信息內(nèi)容、目的號碼等參數(shù)信息編寫新的短消息?！緟?shù)說明】dual_sys：雙卡參數(shù)；sms_init_ptr ：信息的初始內(nèi)容；dest_addr_ptr：目的號碼；dest_addr_len：目的號碼長度。【返回值】無。【考前須知】無。MMIAPISMS_AnswerMessage【函數(shù)原型】voidMMIAPISMS_AnswerMessage(MN_DUAL_SYS_Edual_sys,MMI_STRING_T*sms_init_ptr,uint8*dest_addr_ptr,uint8 dest_addr_len);【函數(shù)功能】根據(jù)雙卡參數(shù)、信息內(nèi)容、目的號碼等參數(shù)回復短消息?！緟?shù)說明】dual_sys：雙卡參數(shù)；sms_init_ptr ：信息的初始內(nèi)容；dest_addr_ptr：目的號碼；dest_addr_len：目的號碼長度。【返回值】無?！究记绊氈繜o。MMIAPISMS_CheckMemHaveEnough【函數(shù)原型】BOOLEANMMIAPISMS_CheckMemHaveEnough(void);【函數(shù)功能】檢查當前的SIM卡和上是否有空間?！緟?shù)說明】無?！痉祷刂怠縏RUE：當前的SIM卡和上有空間；FALSE：無空間。【考前須知】無。MMIAPISMS_IsOrderOk【函數(shù)原型】BOOLEANMMIAPISMS_IsOrderOk(void);【函數(shù)功能】開機后判斷短消息是否已經(jīng)排好順序?！緟?shù)說明】無?！痉祷刂怠縏RUE：短消息已經(jīng)排好順序；FALSE：短消息未排好順序。【考前須知】無。MMIAPISMS_IsSMSReady【函數(shù)原型】BOOLEANMMIAPISMS_IsSMSReady(void);【函數(shù)功能】根據(jù)當前的雙卡設(shè)置情況，判斷當前是否可以開始短消息的開機排序過程?！緟?shù)說明】無?！痉祷刂怠繜o?！究记绊氈繜o。MMIAPISMS_SendInit【函數(shù)原型】voidMMIAPISMS_SendInit(void);【函數(shù)功能】當雙卡設(shè)置變化時，調(diào)用該函數(shù)來對全局變量g_mmisms_deliver進行初始化操作?！緟?shù)說明】無?！痉祷刂怠繜o?！疽蕾囮P(guān)系】g_mmisms_deliver?！究记绊氈繜o。MMIAPISMS_CheckSMSState【函數(shù)原型】voidMMIAPISMS_CheckSMSState(void);【函數(shù)功能】根據(jù)當前的待機模式，獲得是否有未讀短信、當前的空間是否已滿等信息，通過該函數(shù)來刷新ilde界面信息的狀態(tài)圖標?！緟?shù)說明】無?！痉祷刂怠繜o?！究记绊氈繜o。MMIAPISMS_DelSMSByAT【函數(shù)原型】BOOLEANMMIAPISMS_DelSMSByAT(BOOLEAN is_mt_sms,BOOLEAN is_saved_in_sim,MN_SMS_RECORD_ID_Trecord_id);【函數(shù)功能】同步工具根據(jù)存儲位置刪除短信息。【參數(shù)說明】is_mt_sms：是否是接收到的短消息；is_saved_in_sim：是否是保存在SIM上的短消息record_id：標志短消息存儲位置的ID號?！痉祷刂怠縏RUE：成功；FALSE：失敗。【考前須知】無。MMIAPISMS_OpenSmsBox【函數(shù)原型】voidMMIAPISMS_OpenSmsBox(MMISMS_BOX_TYPE_E box_type);【函數(shù)功能】根據(jù)信箱類型參數(shù)翻開信箱窗口?！緟?shù)說明】box_type：信箱類型〔收件箱、發(fā)件箱、草稿箱、已發(fā)信箱〕。【返回值】無。【考前須知】無。MMIAPISMS_ShowNewMsgPrompt【函數(shù)原型】voidMMIAPISMS_ShowNewMsgPrompt(void);【函數(shù)功能】翻開新短信提示窗口?！緟?shù)說明】無?！痉祷刂怠繜o?！究记绊氈繜o。MMIAPISMS_OpenMainMenuWin【函數(shù)原型】voidMMIAPISMS_OpenMainMenuWin(void);【函數(shù)功能】翻開信息主菜單窗口?！緟?shù)說明】無?！痉祷刂怠繜o?！究记绊氈繜o。MMIAPISMS_OpenFreqWordListForCc【函數(shù)原型】voidMMIAPISMS_OpenFreqWordListForCc(MN_DUAL_SYS_Edual_sys,uint8number_len,uint8*number_str);【函數(shù)功能】翻開信息主菜單窗口。【參數(shù)說明】dual_sys：雙卡參數(shù)；number_len：號碼長度；number_str：號碼信息。【返回值】無。【考前須知】無。MMIAPISMS_AppSendSmsForMSD【函數(shù)原型】BOOLEANMMIAPISMS_AppSendSmsForMSD(MN_DUAL_SYS_Edual_sys,MMI_STRING_T*sms_init_ptr,uint8 *dest_addr_ptr,uint8 dest_addr_len);【函數(shù)功能】為MSD模塊發(fā)送短消息?！緟?shù)說明】dual_sys：雙卡參數(shù)；sms_init_pt：信息內(nèi)容；dest_addr_ptr：目的號碼信息；dest_addr_len：目的號碼長度。【返回值】無。【考前須知】無。MMIAPISMS_RestoreFactorySetting【函數(shù)原型】voidMMIAPISMS_RestoreFactorySetting(void);【函數(shù)功能】恢復短信模塊出廠設(shè)置，將短信的存儲位置、是否保存發(fā)送信息等設(shè)置信息恢復為默認的出廠設(shè)置。【參數(shù)說明】無。【返回值】無。【考前須知】無。MMIAPISMS_DeleteMsgInorder【函數(shù)原型】BOOLEANMM