开发文档

1、业务流程介绍

1、用户系统向云信使系统提交短信发送请求；
2、云信使系统处理请求，下发短信；
3、云信使系统收到运营商成功或者失败的发送状态报告后，将状态报告推送给用户系统；
4、云信使系统收到手机回复的短信时，将收到的消息主动推送给用户系统；
5、用户系统也可以主动查询所发送信息的状态报告，以及主动刷新查询手机回复的消息；

2、接口地址与交互方式

接口地址：https://api.yunxinshi.com:8081/SMS.do

交互方式：用户系统以HTTPS POST的方式向服务器（上述接口地址）发送XML数据包，服务器接收并通过验证后开始执行业务流程。服务器将在执行过程中的必要节点向用户系统以HTTP方式回调消息以告知流程进度和其他相关数据；

3.1、接口功能：发送短信 ( MT )

功能说明：
该接口用于发送短信。

发送的XML数据包：
<xml>
   <ActionType>MT</ActionType>
   <UserName></UserName>
   <Token></Token>
   <Phones></Phones>
   <Content></Content>
   <Signature></Signature>
   <RequiredReport>true</RequiredReport>
</xml>

发送的XML数据包参数说明：

返回值：
<xml>
   <errcode></errcode>
   <errmsg></errmsg>
   <SN></SN>
</xml>

返回值参数说明：

3.2、接口功能：主动接收回复的短信 ( MO )

功能说明：
该接口用于主动向云信使服务器查询是否有新的回复短信。如果用户启用了回调消息机制，则不需要使用本接口（启用回调消息机制，当云信使系统收到手机回复消息时，会主动将消息推送给用户）。

发送的XML数据包：
<xml>
   <ActionType>MO</ActionType>
   <UserName></UserName>
   <Token></Token>
</xml>

发送的XML数据包参数说明：

返回值：
<xml>
   <errcode></errcode>
   <errmsg></errmsg>
   <MoCount>(x)</MoCount>
   <MO(x)>
     <FromPhone></FromPhone>
     <ToNumber></ToNumber>
     <Signature></Signature>
     <Content></Content>
     <ReceiveTime></ReceiveTime>
   </MO(x)>
</xml>

返回值参数说明：

3.3、接口功能：查询短信状态报告 ( QueryReport )

功能说明：
该接口用于让用户主动查询某个号码的发送详情和状态报告。

发送的XML数据包：
<xml>
   <ActionType>QueryReport</ActionType>
   <UserName></UserName>
   <Token></Token>
   <SN></SN>
   <Phone></Phone>
</xml>

发送的XML数据包参数说明：

返回值：
<xml>
   <errcode></errcode>
   <errmsg></errmsg>
   <SN></SN>
   <Phone></Phone>
   <Status></Status>
   <SubmitTime></SubmitTime>
   <SendTime></SendTime>
   <ReportTime></ReportTime>
</xml>

返回值参数说明：

3.4、接口功能：新增短信签名 ( AddSignature )

功能说明：
该接口用于增加新的签名，签名必须有实际含义的内容，不能是中性的内容（如“客服”），一个账户可以存在绑定多个签名，提交新签名时，需要填写正确的使用单位/组织名称，并简要描写用途。提交后需要等待审核和备案（一般当天完成），用户可以通过“查询短信签名的状态”接口查询审核状态。

发送的XML数据包：
<xml>
   <ActionType>AddSignature</ActionType>
   <UserName></UserName>
   <Token></Token>
   <Signature></Signature>
   <OrganizationName></OrganizationName>
   <Description></Description>
</xml>

发送的XML数据包参数说明：

返回值：
<xml>
   <errcode></errcode>
   <errmsg></errmsg>
   <Information></Information>
</xml>

返回值参数说明：

3.5、接口功能：删除短信签名 ( DeleteSignature )

功能说明：
该接口用于删除已有的短信签名，删除后不可恢复，如果需要重新使用已经删除的签名，需要重新提交审核。

发送的XML数据包：
<xml>
   <ActionType>DeleteSignature</ActionType>
   <UserName></UserName>
   <Token></Token>
   <Signature></Signature>
</xml>

发送的XML数据包参数说明：

返回值：
<xml>
   <errcode></errcode>
   <errmsg></errmsg>
</xml>

返回值参数说明：

3.6、接口功能：查询短信签名的状态 ( QuerySignature )

功能说明：
该接口用于让用户查询所提交的签名的审核状态、分配的短信号码等信息。

发送的XML数据包：
<xml>
   <ActionType>QuerySignature</ActionType>
   <UserName></UserName>
   <Token></Token>
   <Signature></Signature>
</xml>

发送的XML数据包参数说明：

返回值：
<xml>
   <errcode></errcode>
   <errmsg></errmsg>
   <Signature></Signature>
   <Status></Status>
   <ServiceID></ServiceID>
   <OrganizationName></OrganizationName>
   <Description></Description>
</xml>

返回值参数说明：

3.7、接口功能：查询账号下所有短信签名 ( QueryAllSignature )

功能说明：
该接口用于获取本账号下所有的短信签名及详情。

发送的XML数据包：
<xml>
   <ActionType>QueryAllSignature</ActionType>
   <UserName></UserName>
   <Token></Token>
</xml>

发送的XML数据包参数说明：

返回值：
<xml>
   <errcode></errcode>
   <errmsg></errmsg>
   <DefaultSignature></DefaultSignature>
   <DefaultSignatureServiceID></DefaultSignatureServiceID>
   <SignatureCount>(x)</SignatureCount>
   <Signature(x)>
     <Signature></Signature>
     <Status></Status>
     <ServiceID></ServiceID>
     <OrganizationName></OrganizationName>
     <Description></Description>
   </Signature(x)>
</xml>

返回值参数说明：

4.1、回调消息：回调消息的推送地址和接收响应

回调消息推送地址的配置：
如果用户在管理平台的“业务管理”-“回调消息地址配置”中，配置了“短信状态报告”和“短信上行(回复)信息”的回调消息地址，则当有这两类消息触发时，云信使系统会将消息的详情推送到用户所配置的地址。该地址的配置如下图所示：

用户亦可在每次发送短信时动态变更状态报告回调消息的接收地址，如需实现该动态变更功能，请咨询技术客服。

用户系统接收后的响应：
用户系统成功接收消息后，返回字符串0。云信使系统如果未收到字符串0，则认为推送失败，会再次推送该消息（最多三次）。

4.2、回调消息：收到回复的短信 ( MO )

消息说明：
当云信使系统收到手机用户的回复信息时，实时向用户系统推送该条回复消息，用户系统拆解所收到XML数据包即可获取详情。

用户系统接收的XML数据包：
<xml>
   <PushSN></PushSN>
   <UserName></UserName>
   <Business>SMS</Business>
   <Event>MO</Event>
   <FromPhone></FromPhone>
   <ToNumber></ToNumber>
   <Signature></Signature>
   <Content></Content>
   <ReceiveTime></ReceiveTime>
   <Time></Time>
</xml>

接收的XML数据包参数说明：

4.3、回调消息：收到短信状态报告 ( Report )

消息说明：
当云信使系统收到运营商的发送状态报告时，实时向用户系统推送该条状态报告，用户系统拆解所收到XML数据包即可获取详情。

用户系统接收的XML数据包：
<xml>
   <PushSN></PushSN>
   <UserName></UserName>
   <Business>SMS</Business>
   <Event>Report</Event>
   <SN></SN>
   <Phone></Phone>
   <Status></Status>
   <SubmitTime></SubmitTime>
   <SendTime></SendTime>
   <ReceiveTime></ReceiveTime>
   <Time></Time>
</xml>

接收的XML数据包参数说明：

5、使用在线调试工具快速测试

用户可以登录帮客云信使业务管理系统(https://www.yunxinshi.com/user/)，通过“接口调试工具”--“短信应用”模块，快速测试与调试本功能。调试工具如下图所示：