联通短信网关SP端应用程序接口使用说明(sgip1.2).docVIP

短信网关SP端应用程序接口使用说明 ---- ZTE_SGIP_API 一、 使用说明 本接口遵循 SGIPv1.2 协议标准,以提供消息发送和接收函数的方式, 向 ICP 提 供同联通网关进行信息交换的实现途径.客户可以依据具体需要,利用所提供的函数实 现不同的连接方式(长连接和短连接)以及何时自动建立和中断连接, 除此之外, API 作为应用的接口,对 SGIP 描述的其它功能,象流量控制 重发机制和并发处理都不预 干预,需要应用程序处理 二、 函数说明： 1、 设置源节点代码(set_src_node) ◆ 函数功能 依照SGIP1.2协议，设置源节点代码 返回值 无 参数说明： 参数名 数据长度 数据类型 说明 num 4 整型 SP源节点代码值 2、与网关建立连接（SGIP_Connect） ◆ 函数功能 建立与网关间的连接 返回值 整型 0 连接成功 返回值标识一个连接，在以下的函数中使用 0 连接失败 参数说明： 参数名 数据长度 数据类型 说明 gw_ip 15 字符串 网关的IP地址 port 2 短整型 端口号 username 16 字符串 登陆用户名 passwd 16 字符串 登陆密码 3、向网关提交信息 (SGIP_Submit) 函数功能 向网关提交短信 返回值 =0 标识成功 0 标识发送失败 ◆ 参数说明： 参数名 数据长度 数据类型 说明 conn_id 4 整型 SGIP_Connect 返回的连接标识 sp_dial_num 21 字符串 SP接入号 ICPID 5 字符串 企业代码 service_id 10 字符串 业务代码 fee_type 1 整型 计费类型 01：免费 02：按条 03：包月 04：封顶 05：SP收费。。。。 fee_value 6 字符串 资费代码，以分为单位 give_value 6 字符串 赠送费用代码，以分为单位 agent_flag 1 整型 代收费标志，0：应收；1：实收 mt_flag 1 整型 引起MT消息的原因 0：MO点播引起的第一条MT消息 1：MO点播引起的非第一条MT消 2：非MO点播引起的MT消息。 priority 1 无符号整型 优先级 0-9从低到高 valid_time 15 字符串 存活时间，格式为YYYYMMDDHHMMSS at_time 15 字符串 存活时间，格式为YYYYMMDDHHMMSS report_flag 1 无符号整型 状态报告标记 0：该条消息只有最后出错时要返回状态报告 1：该条消息无论最后是否成功都要返回状态报告 2：该条消息不需要返回状态报告 3：该条消息仅携带包月计费信息，不下发给用户，要返回状态报告 tp_pid 1 无符号整型 一般填0 具体值参见GSM03.40 tp_udhi 1 无符号整型 一般填0 具体值参见GSM03.40 msg_type 1 无符号整型 消息类型 msg_format 1 无符号整型 消息格式 0=ASCII 4=bin 8=UCS2 15=GB charge_mobile 21 字符串 付费号码，如果为空，则该条短消息产生的费用由UserNumber代表的用户支付 user_num 1 无符号整型 接收手机个数 100 dest_mobiles 21*user_num 字符串 接收手机号码，以空格分隔 msg 160 字符串 消息内容 msg_len 1 无符号整型 消息长度 p_seq1 4 无符号整型 返回生成的序列号1 p_seq2 4 无符号整型 返回生成的序列号2 p_seq3 4 无符号整型 返回生成的序列号3 ◆注意： 1、如果建立好连接后一段时间没有发送消息，网关可能会关闭连接， 2、SGIP_Submit返回ERROR_SOCKET_CLOSE ,这时，必须重新建立连接并发送消息 3、p_seq1,p_seq2,p_seq3是函数返回的序列号，可与状态报告中的序列号对应 4、主动与网关断开连接（SGIP_Disconnect） ◆ 函数功能 主动和网关断开链接 返回值 =0 标识成功 0 标识失败 参数说明： 参数名 数据长度 数据类型 说明 Conn_id 4 整型 连接标识 5、 等待并接收 MO 消息（SGIP_Get_MO） ◆ 函数功能 等待并接收 MO 消息 返回值 0 标识成功收到MO消息,返回值是消息类型 可能为MO_MSG或MO_REPORT 0 标识发生错误: 参数说明： 参数名 数据