短信网关SP端应用程序接口使用详细说明.doc

n更多企业学院： 中小企业管理全能版183套讲座+89700份资料总经理、高层管理49套讲座+16388份资料中层管理学院46套讲座+6020份资料国学智慧、易经46套讲座人力资源学院56套讲座+27123份资料各阶段员工培训学院77套讲座+ 324份资料员工管理企业学院67套讲座+ 8720份资料工厂生产管理学院52套讲座+ 13920份资料财务管理学院53套讲座+ 17945份资料销售经理学院56套讲座+ 14350份资料销售人员培训学院72套讲座+ 4879份资料n更多企业学院： 中小企业管理全能版183套讲座+89700份资料总经理、高层管理49套讲座+16388份资料中层管理学院46套讲座+6020份资料国学智慧、易经46套讲座人力资源学院56套讲座+27123份资料各阶段员工培训学院77套讲座+ 324份资料员工管理企业学院67套讲座+ 8720份资料工厂生产管理学院52套讲座+ 13920份资料财务管理学院53套讲座+ 17945份资料销售经理学院56套讲座+ 14350份资料销售人员培训学院72套讲座+ 4879份资料短信网关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汉字 。msg_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：生成包月话单 注意：如果建立好连接后一段时间没有发送消息，网关将关闭连接，CMPP_Submit返回ERROR_SOCKET_CLOSE ，这时，必须重新建立连接并发送消息 3、 查询网关（CMPP_Query） 函数功能向网关提交查询包，并得到查询结果。 返回值=0 标识成功 0 标识失败 参数说明：参数名数据长度数据类型说明conn_id4整型连接标识date8字符串日期，格式为yyyymmddtype1无符号整型查询类型0=查询总数，1=按业务代码查询service10字符串查询代码当Query_Type为0时，此项无效；当Query_Type为1时，此项填写业务类型Service_Id.p_resX结构体返回的结构体注意：username是接入局分配的接入用户名，而不是企业代码。4、 主动与网关断开连接 函数功能主动和网关断开链接 返回值=0 标识成功 0 标识成功 返回值标识一个连接，在以下的函数中使用0 标识失败 参数说明： 参数说明：参数名数据长度数据类型说明gw_ip20字符串网关的IP地址port4短整型端口号，一般为7910username6字符串SP的名称passwd20字符串密码注意：username是接入局分配的接入用户名，而不是企业代码。 6、等待并接收 MO 消息 函数功能连接MO虚拟链路到网关 返回值=0 标识成功 返回值标识一个连接，在以下的函数中使用0 标识失败 参数说明：参数名数据长度数据类型说明Conn_id4整型连接标识p_MOX结构体返回的MO消息注意： 如果没有MO消息将阻塞，直至MO消息到达或连接被网关关闭7、 删除短信（CMPP_Cancel） 函数功能向网关提交查询包，并得到查询结果。 返回值=0 标识成功 0 标识失败 参数说明：参数名数据长度数据类型说明conn_id4整型连接标识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汉字 。msg_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包中得到状态报告 返回值状态报告指针 参数说明参数名数据长度数据类型说明p_MOX结构体CMPP_Get_MO得到的结构体11、链路检测（CMPP_Active） 函数功能保持链路链接正常 返回值0：错误=0：正常 参数说明参数名数据长度数据类型说明Conn_id4整型连接标识三、 结构体说明1、查询结果结构体（Query_Res）：参数名数据长度数据类型说明mt_total_msg4无符号整型从SP接收的用户总数mt_total_user4无符号整型从SP接收的信息总数mt_succ4无符号整型成功转发数量mt_wait4无符号整型待转发数量mt_fail4无符号整型转发失败数量mo_succ4无符号整型向SP成功送达数量mo_wait4无符号整型向SP待送达数量mo_fail4无符号整型向SP送达失败数量2、MO消息参数名数据长度数据类型说明msgID8整型消息IDdest_id21字符串接入号码service_id10字符串业务代码tp_pid1无符号整型见GSM03.40，通常为0tp_udhi1无符号整型见GSM03.40，通常为0msgFormat1无符号整型消息格式sourceUser21字符串发送消息的手机reg_deliver1无符号整型是否为应答消息，1=yes，0=nomsgLen1无符号整型消息长度msg160字符串消息内容3、状态报告参数名数据长度数据类型说明msgID8整型消息ID，与CMPP_Submit中返回的消息ID一一对应stat7字符串状态submit_time10字符串提交时间，MMDDHHMMSSdone_time10字符串完成时间，MMDDHHMMSSdestUser21字符串接收手机smsc_seq4无符号整型短信中心序列号四、常量说明1、状态报告中的状态：常量名说明DELIVRD短信成功传送EXPIRED超过短信的有效期DELETED短信被删除UNDELIV短信无法送达ACCEPTD处于被接受状态UNKNOWN处于非法状态REJECTD处于被拒绝状态DELIVRD短信成功传送2、错误码常量名代表值说明ERROR_OK0正常ERROR_SOCKET_CREATE-100创建socket失败ERROR_CONNECT-101联接到网关失败ERROR_SOCKET_WRITE-102写socket失败ERROR_SOCKET_READ-103读socket失败ERROR_ICP_ID-104错误的SP_IDERROR_AUTH-105认证错误ERROR_MSG_LEN-106短消息长度错ERROR_FEE_CODE-107计费代码错ERROR_SERVICE_ID-108业务代码错ERROR_FLOW_CONTROL-109流量控制错ERROR_SOCKET_CLOSE-110当对Socket操作时，socket关闭ERROR_INTERNAL-200内部错误，一般为信息结构错ERROR_UNKNOWN-201未知错误ERROR_ARGUMENT-202调用api函数参数错五、常见问题解答1、为何联接到网关时网关回复ERROR_AUTH 错误码？答：深讯网关在SP信息里有企业代码、SP名称、密码三项，网关要求SP鉴权时填写的用户名为局方分配的SP名称，而不是企业代码，密码为局方分配的SP密码。2、为何联接到网关时网关回复ERROR_SOCKET_READ错误码？答：造成此问题的原因很可能是你的IP同局方管理人员设置的IP不一致。请与局方管理人员核对数据。3、为何向网关提交短信时会返回ERROR_MSG_LEN错误码？答：CMPP2.0协议有规定：信息长度当Msg_Fmt值为0时：160个字节；其它=140个字节；当你的短信消息长度超长时，网关会返回ERROR_MSG_LEN错误码。4、为何向网关提交短信时会返回ERROR_FEE_CODE错误码？答：深讯信科网关要求资费类别为按条计费时资费代码不能为0；5、接收MO消息时，为何进程会僵死？答：造成此现象的原因很可能是api没有得到网关发来