请求地址
URL地址为:http://apis.xntdx.com/SMS/QueryReport
请求参数定义
序号 | 参数 | 说明 |
---|---|---|
1 | account | 必填参数, 接口Account值。 |
2 | token | 必填参数,接口Token值 。 |
3 | responseType | 可选参数,需要返回的数据格式,默认为xml。0返回json格式,1返回xml格式 |
返回数据说明
用户通过https请求提交到服务器后,服务器返回响应数据。
返回参数说明
序号 | 参数 | 说明 |
---|---|---|
1 | Code | 状态码 |
2 | DataList | 数据列表,请求失败则为空。 数据格式:任务Id#手机号#发送状态#回执代码#回执时间 例如:85475#13800000000#1#DELIVRD#2017-01-01 09:00:00 |
示例
http://apis.xntdx.com/SMS/QueryReport?account=test&token=test
XML数据格式
<?xml version="1.0" encoding="utf-8"?>
<Response>
<Code>0</Code>
<DataList>
<Data>85475#13800000000#1#DELIVRD#2017-01-01 09:00:00</Data>
<Data>85475#13800000000#1#DELIVRD#2017-01-01 09:00:00</Data>
<Data>85475#13800000000#1#DELIVRD#2017-01-01 09:00:00</Data>
</DataList>
</Response>
JSON格式
{"Code":"0","DataList":[{"Data":"85475#13800000000#1#DELIVRD#2017-01-01 09:00:00"},{"Data":"85475#13800000000#1#DELIVRD#2017-01-01 09:00:00"}]}
下载开发文档,并配置。
开发文档下载地址(JAVA/ASP.NET(C#)/ASP/PHP:去下载
示例
- Java
- ASP.NET(C#)
- PHP
/*
* 功能:获取短信状态示例
* 版本:1.3
* 说明:
* 以下代码只是为了方便客户测试而提供的样例代码,客户可以根据自己网站的需要,按照技术文档自行编写,并非一定要使用该代码。
* 该代码仅供学习和研究使用,只是提供一个参考。
*/
package com.kxtsms;
import java.util.HashMap;
import com.kxtsms.sdk.KXTSmsSDK;
public class QueryReportDemo {
public static void main(String[] args) {
String address = "apis.xntdx.com";//远程地址:不带http://
int port = 80;//远程端口
String account = "";//账户
String token = "";//token
short rType = 1;//响应类型 0 json类型,1 xml类型
KXTSmsSDK kxtsms = new KXTSmsSDK();
kxtsms.init(address, port, account, token);
String result = kxtsms.queryReport(rType);
HashMap
/*
* 功能:获取短信状态示例
* 版本:1.3
* 说明:
* 以下代码只是为了方便客户测试而提供的样例代码,客户可以根据自己网站的需要,按照技术文档自行编写,并非一定要使用该代码。
* 该代码仅供学习和研究使用,只是提供一个参考。
*/
using System;
using System.Collections.Generic;
using System.Xml;
namespace KXTDemo.Http
{
public partial class QueryReportPage : System.Web.UI.Page
{
protected void Page_Load(object sender, EventArgs e)
{
string address = "apis.xntdx.com";//不带http:// 的域名或者IP地址
int port = 80;//远程端口
string account = "";//账户
string token = "";//token
short rType = 1;//返回的数据类型 0 json类型,1 xml类型
KXTSDK.KXTSms kxtsms = new KXTSDK.KXTSms(address, port, account, token);
string result = kxtsms.QueryReport(rType);
QueryReportResult smsData = null;
if (!result.Equals(""))
{
//处理接收的数据
if (rType == 0)
{
//Json数据处理代码
try
{
smsData = (QueryReportResult)Newtonsoft.Json.JsonConvert.DeserializeObject(result, typeof(QueryReportResult));//获得用户数据
}
catch (Exception ex)
{
}
}
else
{
//xml数据处理代码
try
{
smsData = new QueryReportResult();
XmlDocument resultXml = new XmlDocument();
resultXml.LoadXml(result);
XmlNodeList nodeList = resultXml.SelectSingleNode("Response").ChildNodes;
foreach (XmlNode item in nodeList)
{
if (item.Name == "Code")
{
smsData.Code = item.InnerText;
}
else if (item.Name == "DataList")
{
smsData.DataList = new List<ReportModel>();
XmlNodeList pnList = item.ChildNodes;
foreach (XmlNode cnItem in pnList)
{
smsData.DataList.Add(new ReportModel { Data = cnItem.InnerText });
}
}
}
}
catch (Exception ex)
{
}
}
}
if (smsData != null)
{
//写自己的业务逻辑代码
}
}
}
/// <summary>
/// 返回结果数据模型
/// </summary>
public class QueryReportResult
{
/// <summary>
/// 状态码
/// </summary>
public string Code { get; set; }
/// <summary>
/// 数据列表
/// </summary>
public List<ReportModel> DataList { get; set; }
}
public class ReportModel
{
/// <summary>
/// 数据
/// </summary>
public string Data { get; set; }
}
}
<?php
/*
* 功能:获取短信状态示例
* 版本:1.3
* 说明:
* 以下代码只是为了方便客户测试而提供的样例代码,客户可以根据自己网站的需要,按照技术文档自行编写,并非一定要使用该代码。
* 该代码仅供学习和研究使用,只是提供一个参考。
*/
include_once("./KXTSmsSDK.php");
$Address = "apis.xntdx.com";//IP地址 不加http://
$Port = "80";//端口
$Account = "";//账户
$Token = "";//API接口密码
/**
* 获取短信发送状态
* 响应类型 0 json类型,1 xml类型
*/
function queryReport($rType)
{
global $Address,$Port,$Account,$Token;
//初始化SDK
$rest = new KXTSmsSDK($Address,$Port,$Account,$Token);
$result = $rest->queryReport($rType);
if($result == NULL ) {
echo "result error!";
break;
}
//自己代码业务逻辑
}
//调用
queryReport(1);
?>