短信dll_API使用手册

  • 格式:doc
  • 大小:280.50 KB
  • 文档页数:18

本文档及其所含信息为内部保密材料,由北京神州数码思特奇信息技术股份有限公司拥有

未经书面授权,不得对外泄露 COPYRIGHT © 2013保留所有权利

C API使用手册

(Vx.x)

北京神州数码思特奇信息技术股份有限公司

二〇一三年四月 集成测试用例

神州数码思特奇信息技术股份有限公司 地址:北京市海淀区上地九街9号数码科技广场二层(100085)

电话 (Tel) :(010) 58856600 传真 (Fax):(010) 62969630

第2 页,共18 页 文档信息

文档名称 API使用手册

电子文档 API使用手册.doc/Microsoft WORD 2003

文件状态 ■ 草 稿 □ 正式发布 □ 正在修改

编 写 人 AC_TEST 日 期 年 月 日

校 对 人 日 期 年 月 日

审 核 人 日 期 年 月 日

批 准 人 日 期 年 月 日

变更记录

变更序号 变更原因 变更页码 变更前版本号 变更后版本号 更改人 批准人 生效日期 备 注

1

集成测试用例

神州数码思特奇信息技术股份有限公司 地址:北京市海淀区上地九街9号数码科技广场二层(100085)

电话 (Tel) :(010) 58856600 传真 (Fax):(010) 62969630

第3 页,共18 页 集成测试用例

神州数码思特奇信息技术股份有限公司 地址:北京市海淀区上地九街9号数码科技广场二层(100085)

电话 (Tel) :(010) 58856600 传真 (Fax):(010) 62969630

第4 页,共18 页 1 引言

1.1 编写目的

【方便第三方用户方便的使用API接口】

1.2 术语定义

【列出测试用例中所用到的专门术语的定义和缩写词的原意。】

1.3 参考资料

【列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源。】 集成测试用例

神州数码思特奇信息技术股份有限公司 地址:北京市海淀区上地九街9号数码科技广场二层(100085)

电话 (Tel) :(010) 58856600 传真 (Fax):(010) 62969630

第5 页,共18 页 2 短信API接口函数说明

2.1 建立连接,并创建收发线程。

2.1.1 函数定义:

int App_Bind( );

2.1.2 输入/输出函数

输入参数: NULL

返回值 : 1 成功;

2 socket连接已经存在

-3 打开文件失败;

-2 bind失败

建立连接的参数 IP地址 用户名 密码 端口 从配置信息文件(mms_cfg.ini)中获取

2.1.3 函数功能说明

建立与服务器的连接,创建收短信/发短信线程。收短信线程处理为:从服务器中取信息放入到收循环队列中。发短信线程处理为:从发循环队列中取短信下发到用户。同时发送链路检测包维持链路的连接。 集成测试用例

神州数码思特奇信息技术股份有限公司 地址:北京市海淀区上地九街9号数码科技广场二层(100085)

电话 (Tel) :(010) 58856600 传真 (Fax):(010) 62969630

第6 页,共18 页 2.1.4 过程流程图

开始与MAS建立连接创建线程从循环队列中获取信息中发送到用户从服务器中获取用户上行的信息.状态报告的话入日志文件成功发收结束线程,释放内存

2.1.5 异常处理:

对出现的错误异常,将以日志输出的方式记录在error_sms_time文件中,

对出现的警告异常,将以日志输出的方式记录在warn_sms_time文件中,

日志文件以天为单位产生.

2.2 断开连接

2.2.1 函数声明:

int App_Unbind() 集成测试用例

神州数码思特奇信息技术股份有限公司 地址:北京市海淀区上地九街9号数码科技广场二层(100085)

电话 (Tel) :(010) 58856600 传真 (Fax):(010) 62969630

第7 页,共18 页 2.2.2 输入/输出函数

输入值: NULL;

返回值:

>0 成功;

1 断开连接之前socket已经关闭

-1 写socket数据失败

-2 断开连接失败

2.2.3 函数功能说明

断开与服务器的连接

2.2.4 异常处理

与服务器连接失败的异常,将以日志文件的方式记录在warn_sms_time日志文件中

2.3 发送短信

2.3.1 函数定义:

int App_Submit(char *Service_Id,char *Dest_terminal_Id,char

*src_id,char *content)

2.3.2 输入/输出参数

App_Submit 属性

输入参数 名称 类型 说明

service_id Char [8] 内部业务代码 集成测试用例

神州数码思特奇信息技术股份有限公司 地址:北京市海淀区上地九街9号数码科技广场二层(100085)

电话 (Tel) :(010) 58856600 传真 (Fax):(010) 62969630

第8 页,共18 页 content Char [] 短信内容

dest_terminal_id Char [32] 目的号码

Src_id Char [21] 源号码(基本号码+子号码)

返回值 >0 成功 -1 普通短信失败

-2 长短信失败

2.3.3 函数功能说明

用户下发的短信首先入到发的循环队列中,发短信线程不停的扫描发送队列,如果发现队列中插入了数据,则下发到MAS服务器.

长短信条数<=10条,内容不超过1400个字符.

2.3.4 异常处理

对出现的错误异常,将以日志输出的方式记录在error_sms_time文件中,

对出现的警告异常,将以日志输出的方式记录在warn_sms_time文件中,

日志文件以天的单位产生.

2.4 接收短信

2.4.1 函数声明:

int App_Deliver(char *Src_Id,char *Dest_Id,char Msg_Content[1024])

2.4.2 输入/输出参数

输入参数:

App_Deliver 属性

输入参数 名称 类型 说明

Msg_Content Char [1024] 短信内容

Dest_Id Char [32] 目的号码 集成测试用例

神州数码思特奇信息技术股份有限公司 地址:北京市海淀区上地九街9号数码科技广场二层(100085)

电话 (Tel) :(010) 58856600 传真 (Fax):(010) 62969630

第9 页,共18 页 Src_Id Char [21] 源号码(基本号码+子号码)

返回值 =0 成功

=-401 状态报告还没有上来

输出参数: 返回用户上行信息的字符指针:

前32个字节为用户上行号码:

接着21个字节为用户上行手机号

后面1024个字节为用户上行的短信内容

2.4.3 函数功能说明:

接收用户上行的短信信息

2.4.4 异常处理

对出现的错误异常,将以日志输出的方式记录在error_sms_time文件中,

对出现的警告异常,将以日志输出的方式记录在warn_sms_time文件中,

日志文件以天的单位产生.

2.5 接收状态报告

2.5.1 函数声明:

int App_report(char *msgid,char *resultp)

2.5.2 输入/输出参数

输入参数: msgid : 更网关返回的ID对应 集成测试用例

神州数码思特奇信息技术股份有限公司 地址:北京市海淀区上地九街9号数码科技广场二层(100085)

电话 (Tel) :(010) 58856600 传真 (Fax):(010) 62969630

第10 页,共18 页 resultp: 短信中心返回的状态报告()

输出参数: 返回用户上行状态报告的字符指针:

前16个字节为用户下行状态报告ID:

接着8个字节为用户下行状态报告状态

后面4个字节为标志(1.成功.0.失败)

返回值: 长度大于10为有下行状态报告过来,否则没状态报告

2.5.3 函数功能说明:

接收用户下行的状态报告

集成测试用例

神州数码思特奇信息技术股份有限公司 地址:北京市海淀区上地九街9号数码科技广场二层(100085)

电话 (Tel) :(010) 58856600 传真 (Fax):(010) 62969630

第11 页,共18 页 3 API使用配置说明:

3.1 界面配置

a. 配置下行通道

选择系统管理—业务管理—短信彩信管理, 配置下发短信业务.(如果存在短信业务,测试的时候可直接参考短信群发业务)

b. 配置第3方接入

选择系统管理—设备管理—应用接入管理:添加一条记录

Eg:

用户名和密码必需是小于,等于6位的数字

MAC地址和IP地址输入你本机的IP地址就可以