展讯短信模块接口介绍

TITLEMocorMMISMSInterfaceUserGuideVersion:1.0.DocCode:SW-MOCOR-UG-0005Date:200重要声明版权声明本文档中的任何内容受《中华人民共和国著作权法》的保护，版权所有©2023，展讯通信，保存所有权利，但注明引用其他方的内容除外。商标声明展讯通信和展讯通信的产品是展讯通信专有。在提及其他公司及其产品时将使用各自公司所拥有的商标，这种使用的目的仅限于引用。不作保证声明展讯通信不对此文档中的任何内容作任何明示或暗示的陈述或保证，而且不对特定目的的适销性及适用性或者任何间接、特殊或连带的损失承当任何责任。保密声明本文档〔包括任何附件〕包含的信息是保密信息。接收人了解其获得的本文档是保密的，除用于规定的目的外不得用于任何目的，也不得将本文档泄露给任何第三方。前言文档说明本文档描述了SMS模块为其他模块提供的接口函数的设计及使用。阅读对象本文档适合SMS模块的开发人员使用。内容介绍本文档包括三个章节，分别为：第一章：概述。简单介绍了SMS接口模块的特点及软件架构；第二章：数据类型。介绍了SMS接口所涉及到的各种数据类型，如枚举、结构等；第三章：API函数。详细描述了SMS接口包含的所有API函数的定义及相关说明。文档约定本文档采用下面醒目标志来表示在操作过程中应该特别注意的地方。注意：提醒操作中应注意的事项。说明：说明比拟重要的事项。相关文档目录TOC\o"1-3"\h\z\t"标题6,1,标题7,2,标题8,3"第1章概述1-11.1系统概述1-11.2SMS模块主要实现功能1-11.3SMS模块在系统中的位置1-1第2章数据类型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结构2-42.3.1MMISMS_BCD_NUMBER_T2-42.3.2MMISMS_ORDER_INFO_T2-5第3章API函数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概述系统概述SMS模块作为短消息的人机界面局部，负责获取，处理由PS层转发的有关短消息的消息以及用户的各种操作，执行相应的动作，并将执行结果反应给PS或者用户，实现短消息的功能。SMS模块主要实现功能SMS模块的主要功能有：接收新短消息：能正确的接收和处理新短消息；写短消息：用户可以写新短消息进行发送或保存；发送短消息： 能够向别的用户发送短消息〔支持群发〕；处理小区播送：接收用户设置的信道和语言的新小区播送；操作已保存的短消息： 对于保存的短消息进行读、编辑、删除、发送、多种方式排序、标记等操作。SMS模块在系统中的位置REF_Ref187652165\h图11描述了SMS模块在系统中的位置。图STYLEREF1\s1SEQ图\*ARABIC\s11SMS模块在总体结构中的位置数据类型常量定义常量名取值说明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;【参数说明】参数名称含义MMISMS_BOX_NONE没有信箱类型MMISMS_BOX_MT收件箱MMISMS_BOX_SENDSUCC已发信箱MMISMS_BOX_SENDFAIL发件箱MMISMS_BOX_NOSEND草稿箱MMISMS_OPERATE_TYPE_E【含义】MMISMS_OPERATE_TYPE_E定义了当前的操作类型，当开机排序完毕后，根据当前的操作类型进入相应的信箱或者菜单。【定义】typedefenum{MMISMS_OPERATE_NONE,MMISMS_WRITE_NEW_SMS,MMISMS_OPEN_BOX,MMISMS_VIEW_MEMORY}MMISMS_OPERATE_TYPE_E;【参数说明】参数名称含义MMISMS_OPERATE_NONE当前无操作MMISMS_WRITE_NEW_SMS写新的短消息MMISMS_OPEN_BOX翻开信箱MMISMS_VIEW_MEMORY查看信息空间MMISMS_MSG_TYPE_E【含义】MMISMS_MSG_TYPE_E定义了信息的类型，包括短消息，彩信、WAPPush消息、WAPOTA消息、彩信OTA消息。【定义】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;【参数说明】参数名称含义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定义了信息的状态，包括已读短消息、未读短消息、已读状态报告、未读状态报告、未下载彩信、未读彩信、已读彩信、发送失败信息、发送成功信息、未发送信息。【定义】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【参数说明】参数名称含义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未发送信息【考前须知】当前的消息类型刚好占3位，如果需要添加类型那么需要增加位数。结构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;参数名称含义number_lennumber数组的BYTE个数npi_ton具体意义请查看GSM04.08number用于存放当前号码数组的bufferMMISMS_ORDER_INFO_T【含义】MMISMS_ORDER_INFO_T定义了信息的状态、号码等信息，用于开机排序和列表显示等。【定义】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;【参数说明】参数名称含义time时间，单位：秒record_id信息的唯一标识mo_mt_type当前信息的状态msg_type信息的类型dual_sy双卡参数display_content在列表中显示的内容senderWAPPush、OTA消息的发件人号码或者电子邮件地址API函数MMIAPISMS_AppInit【函数原型】voidMMIAPISMS_AppInit(void);【函数功能】短消息模块初始化。【参数说明】无。【返回值】无。【考前须知】无。MMIAPISMS_GetDelAllFlag【函数原型】BOOLEANMMISMS_GetDelAllFlag(void);【函数功能】判断当前是否正在删除信息,如果正在删除信息,定时关机等操作将延迟到信息删除完毕后执行。【参数说明】无。【返回值】TRUE：当前正在删除信息；FALSE：当前没有删除信息操作。【考前须知】无。MMIAPISMS_WriteNewMessage【函数原型】voidMMIAPISMS_WriteNewMessage(MN_DUAL_SYS_Edual_sys,MMI_STRING_T*sms_init_ptr,uint8*dest_addr_ptr,uint8dest_addr_len);【函数功能】根据双卡参数、信息内容、目的号码等参数信息编写新的短消息。【参数说明】dual_sys：双卡参数；sms_init_ptr ：信息的初始内容；dest_addr_ptr：目的号码；dest_addr_len：目的号码长度。【返回值】无。【考前须知】无。MMIAPISMS_AnswerMessage【函数原型】voidMMIAPISMS_AnswerMessage(MN_DUAL_SYS_Edual_sys,MMI_STRING_T*sms_init_ptr,uint8*dest_addr_ptr,uint8 dest_addr_len);【函数功能】根据双卡参数、信息内容、目的号码等参数回复短消息。【参数说明】dual_sys：双卡参数；sms_init_ptr ：信息的初始内容；dest_addr_ptr：目的号码；dest_addr_len：目的号码长度。【返回值】无。【考前须知】无。MMIAPISMS_CheckMemHaveEnough【函数原型】BOOLEANMMIAPISMS_CheckMemHaveEnough(void);【函数功能】检查当前的SIM卡和上是否有空间。【参数说明】无。【返回值】TRUE：当前的SIM卡和上有空间；FALSE：无空间。【考前须知】无。MMIAPISMS_IsOrderOk【函数原型】BOOLEANMMIAPISMS_IsOrderOk(void);【函数功能】开机后判断短消息是否已经排好顺序。【参数说明】无。【返回值】TRUE：短消息已经排好顺序；FALSE：短消息未排好顺序。【考前须知】无。MMIAPISMS_IsSMSReady【函数原型】BOOLEANMMIAPISMS_IsSMSReady(void);【函数功能】根据当前的双卡设置情况，判断当前是否可以开始短消息的开机排序过程。【参数说明】无。【返回值】无。【考前须知】无。MMIAPISMS_SendInit【函数原型】voidMMIAPISMS_SendInit(void);【函数功能】当双卡设置变化时，调用该函数来对全局变量g_mmisms_deliver进行初始化操作。【参数说明】无。【返回值】无。【依赖关系】g_mmisms_deliver。【考前须知】无。MMIAPISMS_CheckSMSState【函数原型】voidMMIAPISMS_CheckSMSState(void);【函数功能】根据当前的待机模式，获得是否有未读短信、当前的空间是否已满等信息，通过该函数来刷新ilde界面信息的状态图标。【参数说明】无。【返回值】无。【考前须知】无。MMIAPISMS_DelSMSByAT【函数原型】BOOLEANMMIAPISMS_DelSMSByAT(BOOLEAN is_mt_sms,BOOLEAN is_saved_in_sim,MN_SMS_RECORD_ID_Trecord_id);【函数功能】同步工具根据存储位置删除短信息。【参数说明】is_mt_sms：是否是接收到的短消息；is_saved_in_sim：是否是保存在SIM上的短消息record_id：标志短消息存储位置的ID号。【返回值】TRUE：成功；FALSE：失败。【考前须知】无。MMIAPISMS_OpenSmsBox【函数原型】voidMMIAPISMS_OpenSmsBox(MMISMS_BOX_TYPE_E box_type);【函数功能】根据信箱类型参数翻开信箱窗口。【参数说明】box_type：信箱类型〔收件箱、发件箱、草稿箱、已发信箱〕。【返回值】无。【考前须知】无。MMIAPISMS_ShowNewMsgPrompt【函数原型】voidMMIAPISMS_ShowNewMsgPrompt(void);【函数功能】翻开新短信提示窗口。【参数说明】无。【返回值】无。【考前须知】无。MMIAPISMS_OpenMainMenuWin【函数原型】voidMMIAPISMS_OpenMainMenuWin(void);【函数功能】翻开信息主菜单窗口。【参数说明】无。【返回值】无。【考前须知】无。MMIAPISMS_OpenFreqWordListForCc【函数原型】voidMMIAPISMS_OpenFreqWordListForCc(MN_DUAL_SYS_Edual_sys,uint8number_len,uint8*number_str);【函数功能】翻开信息主菜单窗口。【参数说明】dual_sys：双卡参数；number_len：号码长度；number_str：号码信息。【返回值】无。【考前须知】无。MMIAPISMS_AppSendSmsForMSD【函数原型】BOOLEANMMIAPISMS_AppSendSmsForMSD(MN_DUAL_SYS_Edual_sys,MMI_STRING_T*sms_init_ptr,uint8 *dest_addr_ptr,uint8 dest_addr_len);【函数功能】为MSD模块发送短消息。【参数说明】dual_sys：双卡参数；sms_init_pt：信息内容；dest_addr_ptr：目的号码信息；dest_addr_len：目的号码长度。【返回值】无。【考前须知】无。MMIAPISMS_RestoreFactorySetting【函数原型】voidMMIAPISMS_RestoreFactorySetting(void);【函数功能】恢复短信模块出厂设置，将短信的存储位置、是否保存发送信息等设置信息恢复为默认的出厂设置。【参数说明】无。【返回值】无。【考前须知】无。MMIAPISMS_DeleteMsgInorder【函数原型】BOOLEANMM