M2M接口说明文档.pdf

1、M2M接口说明文档 v2.3 注：红色文字为接口新增功能 Web Service地址：http:/:89/M2MService.asmx 请求方式：SOAP 编码：UTF-8 1. 卡号信息查询 函数名称： M2MSearchInfo 功能描述： 通 过 IMEI/ICCID/Code/IMSI 其 中 之 一 查 询IMEI/ICCID/Code/Mobile/IMSI/ActivationDate/BillingDate/BillingEndDate/PayType。 请求参数详情： 参数 说明 UserName 用户名 UserPwd 密码 SType Type为空: 代表传入IMEI

2、Type = 1: 代表传入IMEI Type = 2: 代表传入ICCID Type = 3: 代表传入Code Type = 4: 代表传入IMSI Key 查询字符串 返回参数详情 参数 说明 IMEI 机器码 ICCID 卡序列号 Code 卡号 Mobile 使用者手机 IMSI IMSI Meals 套餐 Flow 套餐流量（单位：KB） ActivationDate 激活日期(即开卡日期) BillingCycle 计费周期(月) BillingDate 套餐生效日期(计费期) BillingEndDate 套餐失效日期 PayType 付费方式 1：统付 2：个付 Balanc

3、e 卡余额 Result 查询结果 0：查询成功 1：用户名或密码错误 2：无符合条件记录 99：其它错误 2. 实时信息查询 函数名称： M2MSearchTermInfo 功能描述： 通过IMEI/ICCID/Code/IMSI其中之一查询卡的实时状态。 请求参数详情： 参数 说明 UserName 用户名 UserPwd 密码 SType Type为空: 代表传入IMEI Type = 1: 代表传入IMEI Type = 2: 代表传入ICCID Type = 3: 代表传入Code Type = 4: 代表传入IMSI Key 查询字符串 StatusStr 要查询的实时状态 1：使

4、用流量 2：卡状态 3：设备状态 4: 卡余额 查询多个请以逗号“,”分隔 返回参数详情 参数 说明 Code 卡号 Flow 当月使用GPRS流量（单位：KB） CardStatus 卡状态 00：正常 01：单向停机 02：停机 03：预销号 04：销号 05：过户 06：休眠 07：待激活 99：号码不存在 MacStatus 机器状态 0：关机 1：开机 Balance 卡余额 Result 查询结果 0：查询成功 1：用户名或密码错误 2：无符合条件记录 99：其它错误 3.短信发送 函数名称： M2MSmsSend 功能描述： 短信发送 请求参数详情： 参数 说明 UserName

5、 用户名 UserPwd 密码 SendKey 短信标识(唯一,长度16),由用户自行生成的数字+字母组合而成的16位字符串 MobileType 号码类型 0：物联网卡 1：普通号码卡 Mobile 目的号码 Content 内容 返回参数详情 参数 说明 Result 提交结果 0：提交成功 1：用户名或密码错误 2：剩余短信条数不足 3：平台无此号码(物联网卡) 4：号码添加白名单失败(普通号码卡) 5：号码只能为移动号码(普通号码卡) 6：短信标识长度错误 7：短信标识已存在 99：其它错误 4.查询短信发送结果 函数名称： M2MHistorySend 功能描述： 查询短信发送结果

6、请求参数详情： 参数 说明 UserName 用户名 UserPwd 密码 SendKey 短信标识(唯一,长度16),由用户自行生成的数字+字母组合而成的16位字符串 返回参数详情 参数 说明 Mobile 目的号码 SendKey 短信标识 Status 发送状态 -1：等待发送 0：失败 1：成功 Result 查询结果 0：查询成功 1：用户名或密码错误 2：无符合条件记录 99：其它错误 5.查询短信接收 函数名称： M2MHistoryReceive 功能描述： 查询短信接收，每条回复短信只能读取一次，已被读取的回复短信下次不会 再重复读取。 请求参数详情： 参数 说明 UserN

7、ame 用户名 UserPwd 密码 返回参数详情 参数 说明 num 记录总数 Mobile 回复号码 Content 回复内容，请使用url编码进行解码 ReTime 回复时间 Result 查询结果 0：查询成功 1：用户名或密码错误 2：无符合条件记录 99：其它错误 失败返回结果样例： 1 成功返回结果样例： 1064801149979 %23%ef%bc%8618065500000%23555555 2015-03-19 17:43:26 0 1064801149979 %ef%bc%83%ef%bc%8618859700000%ef%bc%83%ef%bc%9f 2015-03-

8、19 17:44:54 0 解码举例： Java版： .URLDecoder.decode(“%E6%B5%99%E6%B1%9F“, “utf-8“); .net版： string newStr =HttpUtility.UrlDecode(“%E6%B5%99%E6%B1%9F“); 引入System.Web 6. 查询指定月份流量（时间范围：12个月内） 函数名称： M2MSearchMonthFlow 功能描述： 通过提供 IMEI/ICCID/Code/IMSI和月份 查询获取卡的流量 限制范围： 时间范围：12个月内 请求参数详情： 参数 说明 UserName 用户名 UserP

9、wd 密码 SType Type为空: 代表传入IMEI Type = 1: 代表传入IMEI Type = 2: 代表传入ICCID Type = 3: 代表传入Code Type = 4: 代表传入IMSI Key 查询字符串 Month 要查询的月份 格式为：yyyyMM或yyyy-MM 返回参数详情 参数 说明 Code 卡号 Month 月份 Flow GPRS流量（单位：KB） Balance 卡余额 Result 查询结果 0：查询成功 1：用户名或密码错误 2：无符合条件记录 3：时间格式错误 99：其它错误 7. 查询当前剩余流量 函数名称： M2MSurplusFlow 功

10、能描述： 通过提供 IMEI/ICCID/Code/IMSI查询卡的当前剩余流量 请求参数详情： 参数 说明 UserName 用户名 UserPwd 密码 SType Type为空: 代表传入IMEI Type = 1: 代表传入IMEI Type = 2: 代表传入ICCID Type = 3: 代表传入Code Type = 4: 代表传入IMSI Key 查询字符串 返回参数详情 参数 说明 Code 卡号 SurplusFlow 当前剩余GPRS流量（单位：KB） Result 查询结果 0：查询成功 1：用户名或密码错误 2：无符合条件记录 3：时间格式错误 99：其它错误 8.

11、短信发送(指定信息格式) 函数名称： M2MSmsSendFmt 功能描述： 向物联网卡发送指定格式的短信 限制范围： 目的号码只能为物联网卡 请求参数详情： 参数 说明 UserName 用户名 UserPwd 密码 SendKey 短信标识(唯一,长度16),由用户自行生成的数字+字母组合而成的16位字符串 Mobile 目的号码 Content 内容 Fmt 移动Cmpp协议信息格式（不带符号的数值） 0：ASCII串 4：二进制信息 8：UCS2编码 15：含GB汉字 等 返回参数详情 参数 说明 Result 提交结果 0：提交成功 1：用户名或密码错误 2：剩余短信条数不足 3：平

12、台无此号码(物联网卡) 6：短信标识长度错误 7：短信标识已存在 8：Fmt格式错误（不带符号的数值） 99：其它错误 9. 设备状态诊段 函数名称： M2MMacState 功能描述： 诊段当前设备状态 请求参数详情： 参数 说明 UserName 用户名 UserPwd 密码 Code 卡号 返回参数详情 参数 说明 Result 提交结果 0：提交成功 1：用户名或密码错误 2：平台无此号码 99：其它错误 10. 查询设备状态诊段结果 函数名称： M2MMacStateResult 功能描述： 查询设备状态诊段结果 请求参数详情： 参数 说明 UserName 用户名 UserPwd

13、密码 Code 卡号 返回参数详情 参数 说明 Code 卡号 MacStatus 设备状态 0：未知 1：开机 LastTime 最后诊段时间 Result 查询结果 0：成功 1：用户名或密码错误 2：平台无此号码 99：其它错误 11. 短信发送/接收通知（后台通知） 需要第三方平台提供通知回调地址（notice_url） M2M卡管理平台 第三方平台 M2M卡管理平台以HTTP Post方式发送短信结果通知(json)给notice_url M2M卡管理平台将在第一时间发送充值通知，以确保第三方平台能够及变更充值订单状态。正常情况M2M卡管理平台应只需发送一次结果通知即可，第三方平台系

14、统在接收到通知后返回指定字符串（OK），返回其他信息均表示未收到通知。M2M卡管理平台会在5分钟之后重新发送充值结果，直到第三方平台系统返回正确的字符串：OK ,或者重发的次数到达6次，M2M卡管理平台则认为第三方平台系统的接口出了问题，将停止发送。 通知Post请求参数说明： 参数 说明 msgtype 短信通知类型 notice_smssend:短信发送 notice_smsreceive:短信接收 count 记录数 datas 结果记录集 data参数说明: 类型 参数 说明 mobile 号码 sendkey 短信标识 content 内容，请使用url编码进行解码 status 发

15、送状态 0：失败 1：成功 notice_smssend （短信发送） sendtime 发送时间 mobile 号码 content 内容，请使用url编码进行解码 notice_smsreceive （短信回复） retime 时间 Post请求示例： notice_smssend示例 “msgtype“:“notice_smssend“, “count“:“2“, “datas“: “mobile“:“xxxx“, “sendkey“:“xxxx“, “content“:“x“, “status“:“x“, “sendtime“:“xxxx“ , “mobile“:“xxxx“, “se

16、ndkey“:“xxxx“, “content“:“x“, “status“:“x“, “sendtime“:“xxxx“ notice_smsreceive示例 “msgtype“:“notice_smsreceive“, “count“:“2“, “datas“: “mobile“:“xxxx“, “content“:“x“, “retime“:“xxxx“ , “mobile“:“xxxx“, “content“:“x“, “retime“:“xxxx“ 12. LBS位置定位 函数名称： M2Mlocation 功能描述： 查询设备的经纬度信息 请求参数详情： 参数 说明 UserNa

17、me 用户名 UserPwd 密码 SType Type为空: 代表传入IMEI Type = 1: 代表传入IMEI Type = 2: 代表传入ICCID Type = 3: 代表传入Code Type = 4: 代表传入IMSI Key 查询字符串 返回参数详情 参数 说明 Code 卡号 Longitude 经度 Latitude 纬度 Result 查询结果 0：成功 1：用户名或密码错误 2：平台无此号码 3：可用定位次数为零 4：定位失败，失败原因详见Message 99：其它错误 Message 结果描述 13. LBS基站信息查询 函数名称： M2MLbsInfo 功能描述：

18、 查询基站的经纬度信息 请求参数详情： 参数 说明 UserName 用户名 UserPwd 密码 Mcc 国家代码 460：中国 Mnc 网络类型 0：移动 1： 联通 Lac 小区号 Cellid 基站号 返回参数详情 参数 说明 Longitude 经度 Latitude 纬度 Radius 定位精度半径（单位：米） Address 位置描述 Result 查询结果 0：成功 1：用户名或密码错误 2：查询参数不完整 3：无基站信息 99：其它错误 Message 结果描述 14. 流量报警/预警通知（后台通知） 需要第三方平台提供通知回调地址（flowmonitor_url） M2M卡

19、管理平台 第三方平台 M2M 卡管理平台每日 0 时以 HTTP Post 方式发送流量报警/预警信息(json)给flowmonitor_url,如需要再次推送可到M2M管理理平台（信息查询-流量信息-推送报警/预警通知）手动推送通知。 通知Post请求参数说明： 参数 说明 msgtype 通知类型 notice_flowmonitor:流量报警/预警通知 count 记录数 datas 结果记录集 data参数说明: 类型 参数 说明 cardcode 号码 taocan 套餐 taocanflow 套餐流量(单位：KB) nearflow 预警阀值(单位：KB) overflow 报警

20、阀值(单位：KB) 0：失败 1：成功 useflow 已使用流量(单位：KB) billingdate 套餐生效日期 billingenddate 套餐失效日期 isnear 是否达到预警值 0：否 1：是 notice_flowmonitor isover 是否达到报警值 0：否 1：是 Post请求示例： “msgtype“:“ notice_flowmonitor “, “count“:“2“, “datas“: “cardcode“:“xxxx“, “taocan“:“xxx“, “taocanflow“:“xxxx“, “nearflow“:“xxxx“, “overflow“:“

21、xxxx“, “useflow“:“xxxx“, “billingdate“:“xxxx-xx-xx“, “billingenddate“:“xxxx-xx-xx“, “isnear“:“1“, “isover“:“1“ , “cardcode“:“xxxx“, “taocan“:“xxx“, “taocanflow“:“xxxx“, “nearflow“:“xxxx“, “overflow“:“xxxx“, “useflow“:“xxxx“, “billingdate“:“xxxx-xx-xx“, “billingenddate“:“xxxx-xx-xx“, “isnear“:“1“, “isover“:“1“ 解码举例： Java版： .URLDecoder.decode(“%E6%B5%99%E6%B1%9F“, “utf-8“); .net版： string newStr =HttpUtility.UrlDecode(“%E6%B5%99%E6%B1%9F“); 引入System.Web