文档详情

短信网关SP端应用程序接口使用详细说明(doc11页)(正式版)

公****
实名认证
店铺
DOCX
101.74KB
约8页
文档ID:392446865
短信网关SP端应用程序接口使用详细说明(doc11页)(正式版)_第1页
1/8

短信网关SP端应用程序接口使用说明---- SXIT_ISMG_CMPP_API使用说明本接口遵循 CMPPv2.0协议标准,以提供消息发送和接收函数的方式, 向SP提供同移动网关进行信息交换的实现途径 .客户可以依据具体需要,利用所提供的函数实现不同的连接方式(长连接和短连接)以及何时自动建立和中断连接, 除此之外, API作为应用的接口,对 CMPP描述的其它功能,象流量控制 、重发机制和并发处理都不预 干预,需要应用程序处理函数说明:1、 与网关建立连接(CMPP_Connect)♦ 函数功能与网关建立网络连接,返回值 >0时,标识一个连接,在以下的函数中使用♦ 返回值>0连接成功<0连接失败参数名数据长度数据类型说明gw_ip20字符串网关的IP地址port4短整型端口号,一般为 7890username6字符串SP的名称passwd20字符串密码入用户名,而不是企业代码♦参数说明:username是接入局分配的接2、向网关提交信息 (CMPP_Submit)♦ 函数功能向网关提交短信♦ 返回值=0 标识成功<0 标识发送失败♦参数说明:参数名数据长度数据类型说明conn_id4整型CMPP_Connect 返回的连接标识p_msg_id8无符号整型[肖息ID,由网关返回msg_level1无符号整型消息级别service_id10字符串业务代码msg_format1无符号整型消息格式0: ASCII串 3:短信写卡操作4:二进制信息 8: UCS2编码15:含 GB 汉字 OOOOOOmsg_src6字符串口肖息来源(SP_Id)fee_type2字符串计费类型01:对“计费用户号码”免费02 :对“计费用户号码”按条计信息费03:对“计费用户号码”按包月收取信息费04:对“计费用户号码”的信息费封顶05:对“计费用户号码”的收费是由 SP实现fee_code6字符串资费代码,以分为单位valid_time14字符串F存活时间,格式为 YYYYMMDDHHMISSat_time14字符串发送时间,格式为 YYYYMMDDHHMISStp_pid1无符号整型参见GSM03.40, 一般为0udhi1无符号整型参见GSM03.40, 一般为0fee_user_type1无符号整型计费用户类型0=对目的收费,1=对源收费,2=对SP收费,3=对charge_num收费charge_mobile21字符串收费号,没有写“ 0”src_mobile21字符串源号,没有写“ 0 ”user_num1无符号整型接收个数 <100dest_mobiles21字符串接收号码,以空格分隔msg160字符串消息内容msg len4整型消息长度need_response1无符号整型是否需要状态报告0:不需要1:需要2:生成包月话单♦汪思:如果建立好连接后一段时间没有发送消息,网关将关闭连接,CMPP_Submit返回ERROR_SOCKET_CLOSE ,这时,必须重新建立连接并发送消息3、查询网关(CMPP_Query)♦函数功能向网关提交查询包,并得到查询结果。

♦返回值=0 标识成功<0标识失败♦参参数名数据长度数据类型说明数conn_id4整型连接标识说date8字符串日期,格式为 yyyymmdd明:type1无符号整型查询类型0=查询总数,1=按业务代码查询♦ 注service10字符串查询代码当Query_Type为0时,此项无效;当Query_Type为1时,此项填与业务典型 Service_Id.息 :usernam e是接 入局分p_resX结构体返回的结构体配的接名,而/、是企业代码4、主动与网关断开连接♦函数功能主动和网关断开链接♦返回值=0 标识成功<0 标识失败入用户♦参参数名数据长度数据类型说明数conn_id4整型连接标识说明:5、 连接 MO 网关(CMPP_Connect_MO )♦函数功能连接MO虚拟链路到网关♦返回值>0标识成功<0 标识失败♦参数说明:返回值标识一个连接,在以下的函数中使用♦参数参数名数据长度数据类型说明说明:gw_ip20字符串网关的IP地址▲ 一、/»♦ T土后:port4短整型端口号,一般为 7910usernameusername6字符串SP的名称是接入局passwd20字符串密码分配的接名,而/、是企业代码。

6、等待并接收 MO消息♦函数功能连接MO虚拟链路到网关♦返回值=0标识成功 返回值标识一个连接,在以下的函数中使用<0 标识失败入用户参数名数据长度数据类型说明Conn_id4整型连接标识p_MOX结构体返回的MO消息♦参数说明:▲ 一、/»♦注思:7、如果没有MO消息将阻塞,直至 MO消息到达或连接被网关关闭删除短信(CMPP_Cancel)函数功能向网关提交查询包,并得到查询结果返回值=0 标识成功<0 标识失败参数名数据<度数据类型说明conn_id4整型r连接标识msg_id8无符号整型消息ID,由网关返回p_Cancel_ Rep_MsgX结构体返回的删除短信响应结果参数说明:8、短连接(以短连接的方式向网关提交消息,直接调用即可) 函数功能向网关提交短信返回值=0 一次连接发送成功<0连接或发送失败参数说明:参数名数据长度数据类型说明gw_ip20字符串网关的IP地址port4短整型端口号,一般为 7900username6字符串SP的名称passwd20字符串密码p_msg_id8无符号整型消息ID,由网关返回msg_level1无符号整型消息级别service_id10字符串业务代码msg_format1无符号整型消息格式0: ASCII串 3:短信写卡操作4:二进制信息 8: UCS2编码15:含 GB 汉字 OOOOOOmsg_src6字符串消息来源(SP_Id)fee_type2字符串计费类型01:对“计费用户号码”免费02 :对“计费用户号码”按条计信息费03:对“计费用户号码”按包月收取信息费04:对“计费用户号码”的信息费封顶05:对“计费用户号码”的收费是由 SP实现fee_code6字符串资费代码,以分为单位valid_time14字符串存活时间,格式为 YYYYMMDDHHMISSat_time14字符串发送时间,格式为 YYYYMMDDHHMISStp_pid1无符号整型参见GSM03.40, 一般为0udhi1无符号整型参见GSM03.40, 一般为0fee_user_type1无符号整型计费用户类型0=对目的收费,1=对源收费,2=对SP收费,3=对charge_num收费charge_mobile21字符串收费号,没有写“ 0”src_mobile21字符串源号,没有写“ 0 ”user_num1无符号整型接收个数 <100dest_mobiles21字符串接收号码,以空格分隔msg160字符串消息内容msg len4整型消息长度need_response1无符号整型是否需要状态报告0:不需要1:需要2:取消包月9、 检查 MO消息是否是状态报告(is_status_report)♦函数功能判断MO包是否为状态报告♦返回值=0 普通MO消息=1 状态报告♦ 参数说明:10、从MO消息得到状态报告(get_status_report)♦ 函数功能从MO包中得到状态报告♦ 返回值状态报告指针参数名数据<度1数据类型说明p_MOX结构体CMPP_Get_MO得到的结构体♦参数说明11、链路检测(CMPP_Active )♦函数功能保持链路链接正常♦ 返回值<0:错误=0:正常参数名数据<度1数据类型说明Conn_id4整型连接标识♦参数说明结构体说明参数名数据长度数据类型说明mt_total_msg4无符号整型从SP接收的用户总数mt_total_user4无符号整型从SP接收的信息总数mt_succ4无符号整型成功转发数量mt_wait4无符号整型待转发数量mt_fail4无符号整型转发失败数量mo_succ4无符号整型向SP成功送达数量mo_wait4无符号整型向SP待送达数量mo_fail4无符号整型向SP送达失败数量1、查询结果结构体(Query_Res):2、MO消息参数名数据长度数据类型说明msgID8整型消息IDdest_id21字符串接入号码service_id10字符串业务代码tp_pid1无符号整型见GSM03.40 ,通常为0tp_udhi1无符号整型见GSM03.40 ,通常为0msgFormat1无符号整型r消息格式 「sourceUser21字符串[发送消息的reg_deliver1无符号整型是否为应答消息,1=yes, 0=nomsgLen1无符号整型;消息长度msg160字符串消息内容3、状态报告参数名数据长度数据类型说明msgID8整型消息ID ,与CMPP_Submit中返回的消息ID——对应stat7字符串状态submit_time10字符串提交时间,MMDDHHMMSSdone_time10字符串完成时间,MMDDHHMMSSdestUser21字符串接收smsc_seq4无符号整型短信中心序列号。

下载提示
相似文档
正为您匹配相似的精品文档
相关文档