宽乐通信WebService接口说明书V1[1].1短信-TO客户(2)

2019-03-16 17:36

参数 uc 类型 String 必选/可选 必选 说明 UC系统分配给第三方服务器注册WebService的用户号码 pw String 必选 “getRandom获取的rand参数+UC密码+UC密码” 经过MD5加密后的字符串(以下加密方式相同) rand url String String 必选 必选 随机数 回调服务器的url 完整的WebService访问地址,如: http://102.71.103.47:8080/jboss-net/services/CallBack ? 返回参数说明: 参数 类型 String 必选/可选 必选 说明 连接id,代表一个第三方服务器与UC Portal的连接。 第三方服务器调用UC WebService接口时携带连接id,UC Portal根据连接id确定回调地址。 connID 返回值说明: >0:为连接通道ID

<0:为失败码,同通用失败码

2.2 收发短信相关接口 2.2.1 发送短信请求

? 接口说明:

第三方服务器可以通过该接口使用UC号码发送短信。

该接口同步返回请求结果,如果UC系统接受此请求则返回发送短信成功码,如果失败则返回错误码(具体成功和错误码请参见如下返回值说明)。

发送短信的状态将通过NotifyStatus调用异步返回给第三方服务器。

? 接口格式:

String sendSMS(String uc, String pw, String rand, String callee[], String isreturn, String cont, int msgid, String connID);

? 输入参数说明:

参数 类型 必选/可选 必选 说明 UC系统分配给第三方服务器发起WebService呼叫的用户号码。 uc String 本次呼叫的使用的UC号码,费用记在该UC号码上。 pw rand String String 必选 “getRandom获取的rand参数+UC密码+UC密码” 经过MD5加密后的字符串 必选 随机数 必选 callee[] String 必选 isreturn String 可选 cont String 必选 msgid int 被叫号码(带区号)可以带多个被叫号码,最多10个。 该短信是否需要回执(0:不需要回执;1:需要回执。) 短信内容(第三方服务器需要对短信内容进行BASE64编码) 由终端生成的短信的标识,终端级唯一,用于接收发送状态、回执时匹配 connID ? 返回参数说明: String 必选 连接通道ID 说明:callee[] = {callee1,callee2…} 参数 res 类型 String 必选/可选 必选 说明 返回值说明: =0:成功返回 <0:失败码如下

失败码说明:

-1:系统异常,发送短信失败;

-4:用户类型非法(该用户没有权限完成该操作) -5:随字符串超时; -7:通道ID不存在; -12:系统超时;

-25:传入参数不合法;

-45:随机数字段长度不合法,或随机字符串无法转成Long型

-47:用户状态不正确(非激活状态)

-71:发送短信UC号码不存在;

-72:发送短信UC号码余额或限额不足; -73:发送短信UC号码状态未激活; -74:发送短信UC号码未开通短信功能; -75:接收短信UC号码不存在; -76:接收短信UC号码状态未激活; -77:接收短信UC号码未开通短信功能; -78:短信发送失败

-79:不能发送短信到接收号码 -84:短信群发超过群发允许的上限 -85:超过短信群发的日最大条数限制 -86:超过短信群发的月最大条数限制

2.2.2 发送短信回执

? 接口说明:

如果发送的短信被终端用户收到,会为短信发送用户提供短信回执。第三方服务器需要提供发送短信回执接口接收短信回执。

? 接口格式: void EchoOfSendSMS(String ucNum, String cee, int msgid, int res, String recvt);

? 输入参数说明:

参数 ucNum 类型 必选/可选 String 必选 说明 发送方号码,用于第三方服务器定位发送客户端 cee msgid String int 必选 必选 接收方号码 短消息编号,用于客户端匹配请求消息 res recvt int String 必选 必选 回执的结果 短消时间 回执的结果说明:

1: 接收方成功接收短信 -1: 系统异常; -12:系统超时;

-92:被叫号码不存在、对方短信中心异常、被叫号码状态异常等等

2.2.3 接收短信请求

? 接口说明:

第三方服务器需要提供接收短信WebService接口接收在其上登记的UC号码的短信。 该接口同步返回结果,如果第三方服务器成功接收短信,将结果立即返回。 ? 接口格式:

String RecvSMS(String caller, String time, String cont, String ucNum);

? 输入参数说明:

参数 caller time 类型 必选/可选 String String 必选 必选 说明 短信的发送者号码 短信发送时间,以http接口传过来的时间为准 必选 cont String 必选 ucNum ?

返回参数说明:

短信内容(第三方服务器需要对短信内容进行BASE64解码) 短信接受者号码(接收短信的UC号码) String 参数 res 类型 String 必选/可选 必选 说明 返回值说明: =0:成功返回 <0:失败码

失败码说明:

-1:接收失败

2.3 第三方服务器需要实现通用回调函数

?

接口说明:

第三方服务器需要实现NotifyStatus函数用于接收相关参数并对相关参数进行处理。 ? 接口格式:

void NotifyStatus(int eventID, String sessionID,int res,String

para1);

? 输入参数说明: 参数 eventID 类型 int 必选/可选 必选 说明 接口事件ID:区别相应接口调用返回以及对其他事件的上报。 sessionID res para1 String int String 必选 呼叫标识/会议标识/短信标识/传真标识: 必选 可选 失败码/状态码。 参数1 其中失败码值小于0,全局编码;状态码与回调事件相关,值大于或等于0;para1参数的具体意义与回调事件相关。参见回调事件的具体说明。

2.3.1 设置回调地址回调事件 一、部分返回参数说明: eventID para1 int String 必选 可选 1 二、状态码说明:1:回调地址发生更改 三、失败码说明:见回调事件通用失败码


宽乐通信WebService接口说明书V1[1].1短信-TO客户(2).doc 将本文的Word文档下载到电脑 下载失败或者文档不完整,请联系客服人员解决!

下一篇:九年级(英语)试卷 - 图文

相关阅读
本类排行
× 注册会员免费下载(下载后可以自由复制和排版)

马上注册会员

注:下载文档有可能“只有目录或者内容不全”等情况,请下载之前注意辨别,如果您已付费且无法下载或内容有问题,请联系我们协助你处理。
微信: QQ: