短消息接口WS开发说明

WEBSERVICES接口说明

1接口说明

集团客户应用系统和应用插件通过此接口收发短消息。WebService方式通信适配插件收到应用插件的发送请求后，通过MAS服务器基座中的SMS通信协议模块发送SMS；当从SMS通信协议模块收到SMS后，通过此接口将短消息发送给集团客户应用系统和应用插件。 2流程说明

短消息接口包括发送和接收两个流程。

应用系统或应用插件WebService方式通信适配插件应用发送短信sendSmsRequestsendSmsResponse应用主动获取短信发送状态getSmsDeliveryStatusRequestgetSmsDeliveryStatusResponse通知应用短信发送状态notifySmsDeliveryStatusRequestnotifySmsDeliveryStatusResponse

图5-4 短消息发送流程示意图

发送短信由应用系统或应用插件发起，通过sendSms操作实现。在提交短信发送请求之后，应用侧可以主动获取短信发送状态（getSmsDeliveryStatus操作），或由WebService方式通信适配插件通知应用侧短信发送状态（notifySmsDeliveryStatus操作）。

应用系统或应用插件WebService方式通信适配插件应用主动发起接收短信GetReceivedSmsRequestGetReceivedSmsResponse通知应用短信到达notifySmsReceptionRequestnotifySmsReceptionResponse

图5-5 短消息接收流程示意图

接收短信可以通过两种方式，一种是由应用侧发起（GetReceivedSms操作），WebService方式通信适配插件将所接收到的发往该应用的短信在响应中提交；第二种是由WebService方式通信适配插件通知应用侧有短信到达（notifySmsReception操作），短信内容包含在请求中。 3数据类型

DeliveryStatus 含义：传送状态

数据类型：枚举，定义如下： 参数 Delivered DeliveryImpossible 描述 对应MAS网关状态 3000 表示发送到网关，等待状态报告【中间状态，状态会改变】 对应MAS网关状态 3002 表示发送失败【最终状态，状态不会改变】 CANNOTFINDROUTER_ERROR 对应MAS网关状态 1007 表示没有适合的路由，发送失败【最终状态，状态不会改变】 DeliveryToTerminal 对应MAS网关状态 4000 表示已经发送到手机【最终状态，状态不会改变】 对应MAS网关状态 1000，表示已经提交到到MAS，还没有发送到网关【中间状态，状态会改变】 对应MAS网关状态 2002 表示内容有第敏感词，发送失败【最终状态，状态不会改变】 DeliveryNotificationNotSupported KeyWordFilterFailed DeliveryInformation 含义：传送消息

数据类型：结构。定义如下： 参数 Address DeliveryStatus 类型 xsd: anyURI DeliveryStatus 描述 目的地址信息。 发送状态。 SMSMessage

含义：短消息信息

数据类型：结构。定义如下： 参数 Message SmsServiceActivationNumber 类型 xsd:string xsd: anyURI 描述 短消息中的文本。 与被调用的消息业务相关的号码，即，终端用来发送消息的目标地址。 指示短消息发送者的名称，即作为消息发起者显示在用户终端上的名称。 编码格式。 SenderAddress xsd:anyURI MessageFormat MessageFormat MessageFormat

含义：消息编码类型

数据类型：枚举。定义如下： 参数 ASCII UCS2 GB18030 GB2312 Binary 描述 ASCII字符。 USC2格式的UniCode字符。 GB18030格式的中文字符。 GB2312格式的中文字符。 二进制短信，用十六进制字符串。 SendMethodType 含义：发送选项

数据类型：枚举。定义如下： 参数 Normal Instant Long Structured 4接口定义 4.1发送短消息

操作：sendSms

sendSms调用是由应用系统或插件发起，请求发送一条短消息到一个指定地址（或地址集合），该短消息由Message描述，目的地址由DestinationAddress描述。对于可任意扩展服务代码的应用，应用可以通过ExtendCode填写应用内部的扩展码，MAS服务器需自动在其前面补充为该业务分配的长服务号码。对本接口的调用，MAS服务器应返回RequestIdentifier标识这次发送请求。如果消息的长度大于可支持的最大长度，此条消息将被分成若干条短消息进行发送。应用通过DeliverResultRequest告知是否需要返回状态报告。MAS根据要求用notifySmsDeliveryStatus接口返回状态报告。

输入：sendSmsRequest

描述 普通短信 普通短信立即显示 长短信 长度小于160字节，但UDHI需置为1 参数 ApplicationID DestinationAddresses ExtendCode 类型 xsd:string xsd:anyURI [0..unbounded] xsd:string 可选性 M M O 描述 应用ID或插件的ID。 短消息要被发送到的地址。 群发短消息的最大数量为254。 指由该应用填写的内部扩展号码。MAS服务器需自动补充为此业务分配的长服务号码。 在短消息中发送的文本。 消息编码类型。 发送消息选项。 指示是否需要网络侧返回递交状态报告。若无，则不返回。True表示需要网络侧返回递交状态报告，false表示不需要网络侧返回递交状态报告。 描述 标识一个特定的短消息发送请求。 Message MessageFormat SendMethod DeliveryResultRequest xsd：string MessageFormat SendMethodType xsd:boolean M M M O 输出：sendSmsResponse 参数 RequestIdentifier 类型 xsd:string 可选性 M 差错： 业务异常：

? SVC0001 - 业务错误.

? SVC0002 - 不合法的输入值. ? SVC0004 - 不合法地址. ? SVC0006 - 不合法的组. ? SVC0280 - 消息过长. 策略异常：

? POL0001 - 策略错误. ? POL0003 –地址超界. ? POL0006 - 组不被允许.

? POL0007 - 嵌套的组不被允许. ? POL0008 - 不允许支付.

操作：GetSmsDeliveryStatus

用于集团客户应用系统或应用插件查询短消息的发送状态。集团客户应用系统或应用插件通过requestIdentifier指定查询对应的发送请求，状态信息由DeliveryStatus返回。

输入：GetSmsDeliveryStatusRequest 参数 ApplicationID RequestIdentifier 类型 xsd:string xsd:string 可选性 M M 描述 应用ID或插件ID。 在发送短信时由WebService方式通信适配插件分配的发送请求标识。 描述 输出：GetSmsDeliveryStatusResponse 参数 类型 可选性 DeliveryStatus DeliveryInformation[0..unbounded] M 列出短消息发送状态。 差错： 业务异常：

? SVC0001 - 业务错误.

? SVC0002 - 不合法的输入值. 策略异常：

? POL0001 - 策略错误 4.2短消息通知

操作：notifySmsReception

通信适配插件收到发送到特定地址的短消息时，调用本接口，通知集团客户应用系统和应用插件有短消息到达，前提是应用系统或插件具备Web服务端。

输入：notifySmsReceptionRequest

参数 Message 类型 SmsMessage 可选性 M 描述 在短消息中发送的文本。 输出：notifySmsReceptionResponse 无。 差错： 无。

操作：notifySmsDeliveryStatus

应用系统或应用插件通过通信适配插件发送了短消息之后，通信适配插件对该短消息的发送分配了一个标识符RequestIdentifier。当通信适配插件获得状态报告后，调用本接口将短消息的发送状态报告给应用侧，前提是应用系统或插件具备Web服务端。状态信息在DeliveryInfomation中具体描述。

输入：notifySmsDeliveryStatusRequest 参数 RequestIdentifier DeliveryInformation 类型 xsd:string deliveryInformation[0..unbounded] 可选性 M M 描述 标识一个短消息发送请求。 短消息递交状态参数。 输出：notifySmsDeliveryStatusResponse 无。 差错： 无。 4.3短消息接收

操作：GetReceivedSms

用于集团客户应用系统和应用插件从通信适配插件获取接收到的短消息。 通信适配插件返回receivedSms，包含短消息的发送者和内容。 输入：GetReceivedSmsRequest

参数 ApplicationID 参数 ReceivedSms 类型 xsd:string 类型 SmsMessage [0..unbounded] 可选性 M 可选性 M 描述 应用ID或插件ID。 描述 接收的短消息 输出：GetReceivedSmsResponse

差错： 业务异常：

? SVC0001 - 业务错误.

? SVC0002 - 不合法的输入值. 策略异常：

? POL0001 - 策略错误 4.4差错定义

业务异常：

SVC0280: 消息过长 参数 Message Id Text Variables 参数 Message Id Text Variables 4.5服务策略

服务策略在MAS服务器上进行配置。 参数 GroupSupport NestedGroupSupport AllowNotification Maximum of Message 类型 xsd:boolean xsd:boolean xsd:Boolean xsd: int 描述 组可被包含在地址中。 在组定义中支持嵌套的组。 是否支持通知。 南向接口消息内容大小的最大值，超过进行拆分。 描述 SVC0280 消息过长。最大长度是%1字符。 %1在一个消息中允许的字符的数目。 描述 SVC0281 消息部分%1的数据格式不被认识。 %1带有不被认识的数据格式的消息。 SVC0281: 未知的数据格式

2. WSDL文件获取方式

访问http://ip:port/services 获取接口描述文件

本文来源：https://www.bwwdw.com/article/s6mv.html