短消息接口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对应MAS网关状态3000表示发送到网关，等待状态报告【中间状态，状态会改变】DeliveryImpossible对应MAS网关状态3002表示发送失败【最终状态，状态不会改变】CANNOTFINDROUTER_ERROR对应MAS网关状态1007表示没有适合的路由，发送失败【最终状态，状态不会改变】DeliveryToTerminal对应MAS网关状态4000表示已经发送到手机【最终状态，状态不会改变】DeliveryNotificationNotSupported对应MAS网关状态1000，表示已经提交到到MAS，还没有发送到网关【中间状态，状态会改变】KeyWordFilterFailed对应MAS网关状态2002表示内容有第敏感词，发送失败【最终状态，状态不会改变】DeliveryInformation含义：传送消息数据类型：结构。定义如下:参数类型描述Addressxsd:anyURI目的地址信息。DeliveryStatusDeliveryStatus发送状态。SMSMessage含义：短消息信息数据类型：结构。定义如下:参数类型描述Messagexsd:string短消息中的文本。SmsServiceActivationNumberxsd:anyURI与被调用的消息业务相关的号码，即，终端用来发送消息的目标地址。SenderAddressxsd:anyURI指示短消息发送者的名称，即作为消息发起者显示在用户终端上的名称。MessageFormatMessageFormat编码格式。MessageFormat含义：消息编码类型数据类型：枚举。定义如下:参数描述ASCIIASCII字符。UCS2USC2格式的UniCode字符。GB18030GB18030格式的中文字符。GB2312GB2312格式的中文字符。Binary—进制短信，用十八进制字付串。SendMethodType含义：发送选项数据类型：枚举。定义如下:参数描述Normal普通短信Instant普通短信立即显示Long长短信Structured长度小于160字节，但UDHI需置为14接口定义4.1发送短消息操作：sendSmssendSms调用是由应用系统或插件发起，请求发送一条短消息到一个指定地址（或地址集合），该短消息由Message描述，目的地址由DestinationAddress描述。对于可任意扩展服务代码的应用，应用可以通过ExtendCode填写应用内部的扩展码，MAS服务器需自动在其前面补充为该业务分配的长服务号码。对本接口的调用，MAS服务器应返回RequestIdentifier标识这次发送请求。如果消息的长度大于可支持的最大长度，此条消息将被分成若干条短消息进行发送。应用通过DeliverResultRequest告知是否需要返回状态报告。MAS根据要求用notifySmsDeliveryStatus接口返回状态报告。输入：sendSmsRequest参数类型可选性描述ApplicationIDxsd:stringM应用ID或插件的ID。DestinationAddressesxsd:anyURI[O..unbounded]M短消息要被发送到的地址。群发短消息的最大数量为254。ExtendCodexsd:stringO指由该应用填写的内部扩展号码。MAS服务器需自动补充为此业务分配的长服务号码。Messagexsd:stringM在短消息中发送的文本。MessageFormatMessageFormatM消息编码类型。SendMethodSendMethodTypeM发送消息选项。DeliveryResultRequestxsd:booleanO指示是否需要网络侧返回递交状态报告。右无，则不返回。True表示需要网络侧返回递交状态报告，false表示不需要网络侧返回递交状态报告。输出：sendSmsResponse参数类型可选性描述RequestIdentifierxsd:stringM标识一个特疋的短消息发送请求。差错:业务异常：SVC0001-业务错误.SVC0002-不合法的输入值.SVC0004-不合法地址.SVC0006-不合法的组.SVC0280-消息过长.策略异常：POL0001-策略错误.POL0003-地址超界.POL0006-组不被允许.POL0007-嵌套的组不被允许.POL0008-不允许支付.操作：GetSmsDeliveryStatus用于集团客户应用系统或应用插件查询短消息的发送状态。集团客户应用系统或应用插件通过requestIdentifier指定查询对应的发送请求，状态信息由DeliveryStatus返回。输入：GetSmsDeliveryStatusRequest参数类型可选性描述ApplicationIDxsd:stringM应用ID或插件ID。RequestIdentifierxsd:stringM在发送短信时由WebService方式通信适配插件分配的发送请求标识。输出：GetSmsDeliveryStatusResponse参数类型可选性描述DeliveryStatusDeliveryInformation[O..unbounded]M列出短消息发送状态。差错：业务异常：SVC0001-业务错误.SVC0002-不合法的输入值.策略异常：POL0001-策略错误4.2短消息通知操作：notifySmsReception通信适配插件收到发送到特定地址的短消息时，调用本接口，通知集团客户应用系统和应用插件有短消息到达，前提是应用系统或插件具备Web服务端。输入：notifySmsReceptionRequest参数类型可选性描述MessageSmsMessageM在短消息中发送的文本。输出：notifySmsReceptionResponse无。差错：无。操作：notifySmsDeliveryStatus应用系统或应用插件通过通信适配插件发送了短消息之后，通信适配插件对该短消息的发送分配了一个标识符RequestIdentifier。当通信适配插件获得状态报告后，调用本接口将短消息的发送状态报告给应用侧，前提是应用系统或插件具备Web服务端。状态信息在DeliveryInfomation中具体描述。输入：notifySmsDeliveryStatusRequest参数类型可选性描述RequestIdentifierxsd:stringM标识一个短消息发送请求。DeliveryInformationdeliveryInformation[0..unbounded]M短消息递交状态参数。输出：notifySmsDeliveryStatusResponse无。差错：无。4.3短消息接收操作：GetReceivedSms用于集团客户应用系统和应用插件从通信适配插件获取接收到的短消息。通信适配插件返回receivedSms,包含短消息的发送者和内容。输入：GetReceivedSmsRequest参数类型可选性描述ApplicationIDxsd:stringM应用ID或插件ID。输出：GetReceivedSmsResponse参数类型可选性描述ReceivedSmsSmsMessage[O..unbounded]M接收的短消息差错:业务异常：SVC0001-业务错误.SVC0002-不合法的输入值策略异常：POL0001-策略错误4.4差错定义业务异常：SVC0280:消息过长参数描述MessageIdSVC0280Text消息过长。最大长度是%1字符。Variables%1在一个消息中允许的字符的数目。SVC0281:未知的数据格式参数描述MessageIdSVC0281Text消息部分%1的数据格式不被认识。Variables%1带有不被认识的数据格式的消息。4.5服务策略服务策略在MAS服务器上进行配置。参数类型描述GroupSupportxsd:boolean组可被包含在地址中。NestedGroupSupportxsd:boolean在组定义中支持嵌套的组。AllowNotificationxsd:Boolean是否支持通知。MaximumofMessagexsd:int南向接口消息内容大小的最大值，超过进行拆分。2.WSDL文件获取方式访问http://ip:port/services获取接口描述文件',)