第三方开发接口命令格式

1、第接口命令格式(SAMSPI-3.07)权责：此第接口，免费提供给RG-SAM产品的客户使用，客户可将此接口程序及配套文档提供给委托的第锐捷网络开发商进行开发，或者自行使用此接口程序及配套文档进行开发。福建星网尽量保障程序和说明的正确性，但不为因为不可避免的误差和不明确的地方，以及阅读程序和配套文档的理解错误导致客户自行或者委托给第开发商使用此接口程序及配套文档的时候导致开发程序不能达到预期的效果造成的一切损失承担责任。福建星网锐捷网络承诺在福建星网锐捷网络认为必要的时候，提供进一步的说明和有限的协助以正确的使用本第接口。注意事项：1.兼容 SAM 2.X 第接口命令。2.SAM 2.X 中的

2、账号模板在 SAM 3.X 中对应为用户模板。3.如果服务端是 SAM 3.X ， 上网明细查询(QUERYAR) 指令中的 INPUTBYTES 和OUTPUTBYTES 属性不支持，始终返回 0。4.如果服务端是 SAM 3.1-4127-SP3 以下版本，则不支持用户暂停(SUSPENDUSER)指令，调用此指令始终返回成功。SAM 3.1-4127-SP3 及以上版本支持用户暂停指令。1. 格式命令接口命令采用字符串表示，格式为：cmd :ATTR1=”VALUE1”, ATTR2=”VALUE2”,.ATTRn=”VALUEn”;cmd 必须是第接口中定义令，不区分大小写。ATTRI

3、BUTE 是该命令中可以传递的属性，VALUE 是该属性的值。ATTRIBUTE 不区分大小写，VALUE 区分大小写。一个命令的属性分为必须属性和非必须属性。非必须属性可以不用填写，此时这些属性取默认值，默认值的具体设置见各个命令的参数说明。注意：1)”=”两边都没有空格2)cmd 和 ATTR 都不区分大小写，VALUE 区分大小写返回值所有命令的返回值都是字符串,分为如下三种类型:1)SUC操作成功,无返回结果.只用于操作性质令,表示操作命令成功执行,且无返回结果.返回值是此类型令, 只在操作完全成功的情况下返回SUC，任何错误都返回为ERR。2)ERR操作失败.任何命令都有可能返回ER

4、R,表示命令执行失败,且带有失败原因.3)ACK-操作成功,有返回结果. 返回值是此类型令, 只在操作成功并有数据的情况下返回 ACK，其他任何错误都返回为 ERR，包括没有查询到符合条件的数据。SUC 格式：SUC;ERR 格式：ERR: ERRORTEXTACK 格式：如果返回的是单条,格式为ACK:ATTR1=”VALUE1”,ATTR2=”VALUE2”,.ATTRn=”VALUEn”;如果返回的是结果集,格式为:ACK:ATTR1=”VALUE1”,ATTR2=”VALUE2”,.ATTRn=”VALUEn”;ACK:ATTR1=”VALUE1”,ATTR2=”VALUE2”,.AT

5、TRn=”VALUEn”;ACK:ATTR1=”VALUE1”,ATTR2=”VALUE2”,.ATTRn=”VALUEn”;即结果集就是单条的简单叠加.特殊符号对于命令和ACK 格式中的 VALUE，必须保证不出现下列字符：4)不可见字符5)回车(r)，换行(n)如果出现下列字符，必须用转义序列代替6)“用转义序列”7)用转义序列2. 命令手册用户ADDUSERADDUSER:ATTR1=”VALUE1”,ATTR2=”VALUE2”.ATTRn=”VALUEn”;示例: ADDUSER:USERID=”test”,PASSWORD=”111”;(1)说明添加用户,用户信息除了几个必需信息外

6、,其他信息可选,未设置的属性将取系统默认值。(2)服务端版本要求参数 BACLNAME、SELFSERVICEPRIVILEGE 从 SAM3.13 版本开始支持。参数 AUTOLOGICDESTROYTIME 从SAM3.13SP5 版本开始支持。(3)参数说明名称输入限制是否必需默 认值说明USERID只能为数字,英文字母、中文和下划线.长度过 32 个字符是无用户登录名PASSWORD只能为数字和英文字母,过 16 个字符是无用户USERNAME过32 个字符否无用户真实USERGROUPNAME必需是 SAM 系统中的用户组名否root用户所属的用户组ATNAME必需是 SAM 系统中

7、的用户模板名称否无用户模板名称, 如果设置了USERGROUPNAME, 而没有设置 ATNAME,将取用户组的默认用户模板.PACKAGENAME必需是 SAM 系统中的用户套餐名称否无用户套餐名称SEX0 ,1 ,2否0用户0-无选择1-男2-女FREEAUTHEN1,2否1是否免认证1-认证用户2-免认证用户CERTTYPE0,1,2,3,4否0证件类型0-无选择12 学生证3 军官证4 护照CERTNO只能为数字,英文字母和下划线.长度 过32 个字符否无证件号码EDU0,1,2,3,4,5,6,7否无学历无选择小学初中高中专科本科67博士ADDRESS过64 个字符否无地址TCODE

8、6 位数字否无只能是数字和“-”号,过 32个字符否无号码MOBILE只能是数字和“-”号,过 32个字符否无移动合法的 地址,过 64个字符否无地址USERIP合法的 IP 地址否无用户 IP 地址USERMAC合法的 MAC 地址否无用户 MAC 地址NASIP合法的 IP 地址否无NAS IPNASPORT不超过 4 位数的整数否无NAS 端口AUTHORIP合法的 IP 地址否无下传给用户的 IPFILTERID不超过 250 个字符否无控制LOGININFO不超过 128 个字符否无用户登录信息USRIVILEGE正整数否0用户权限0 表示不下传USERVLAN不超过 4 位数的整数

9、否0用户下传VLAN,0 表示不下传BACLNAME必须是 SAM 系统中的 BACL 名称否无用户的 BACLSELFSERVPERM必须是 SAM 系统中的自助权限名称否所 有自 助权限用户所具备的自助权限。AUTOLOGICDESTROYTIME格式必须为合法的日期格式： yyyy-mm-dd否无用户自动预销户时间(4) 返回类型SUC;PAY用户PAY:USERID=”userid”,FEE=”x” ,TXID=”yyyyyyyy”;示例:PAY:USERID=”test”,FEE=”100”,TXID=”1234”;(1)说明用户接口。TXID:TXID 参数，是重传命令。操作的唯一

10、标识。第系统在命令调用失败时，可以使用相同的 TXID服务端对同一 TXID 的命令只处理一次。TXID 所对应的命令一旦处理成功，再调用该命令，服务端始终返回 SUC，同时并不会影响 SAM 中用户的账户余额。TXID 由服务端生成，客户端在调用 PAY 命令前通过NEWTXID 命令获得 TXID。TXID 只能为数字，英文字母和下划线，区分大小写，长度必须大于 1，且不超过 32 个字符。TXID 是可选参数，不传 TXID 时每个命令均当作不同的操作进行处理，如果命令中包含 TXID，但格式不符合要求，服务端返回错误：ERR:TXID 格式错误！命令重传时，命令的所有内容必须保持不变，

11、包括内容、格式(包括字母大小写)、顺序。TXID 相同的指令，其它字段必须相同，如果其它字段发生变化，服务端将返回失败。ERR:发生错误时的返回值有两种：系统错误和业务错误。如果是系统错误，ERRORTEXT 以文本“系统错误”开头作为标志，业务错误则没有这个标志。示例：ERR:用户不存在！ERR:系统错误网络连接错误！发生系统错误时，SAM 中用户的账户余额状态不确定，客户端必须重传命令，直到服务端返回非系统错误。即：返回成功或返回业务错误。发生业务错误时，SAM 中用户的账户余额不会变化，客户端不必重传命令。(2)服务端版本要求TXID 参数在SAM 3.1-4127-SP3 及以上版本才

12、支持。(3)参数说明(4)返回类型SUC;用户预存待扣款 PAYPREFEEPAYPREFEE:USERID=”userid”,FEE=”x” ,TXID=”yyyyyyyy”;示例:PAYPREFEE:USERID=”test”,FEE=”100”,TXID=”1234”;(1)说明预存用户待扣款。(2)服务端版本要求预存待扣款命令从SAM 3.1-4127-SP3 开始支持。(3)参数说明名称输入限制是否必需默认值说明USERID只能为数字,英文字母和下划线. 长度 过 32 个字符是无需要预存待扣款的用户的登录名名称输入限制是否必需默认值说明USERID只能为数字,英文字母和下划线. 长

13、度 过 32 个字符是无需要缴费的用户的登录名FEE最多 2 位小数是无缴费金额,：元TXID只能为数字，英文字母和下划线，区分大小写，长度必须大于 1，且不超过 32 个字符否无缴费操作的唯一标识。(4) 返回类型SUC;用户暂停 SUSPENDUSERSUSPENDUSER:USERID=”userid”;实例:SUSPENDUSER:USERID=”test”;(1)说明暂停一个用户(2)服务端版本要求SAM 3.0-3428 及以上版本均支持此命令，但 SAM能，SAM 3.1-4127-SP3 以下版本始终返回成功。3.1-4127-SP3 及以上版本才实际支持暂停功(3)参数说明(

14、4)返回类型SUC;用户恢复 RESUMEUSERRESUMEUSER:USERID=”USERID”;实例: RESUMEUSER:USERID=”test”;名称输入限制是否必需默认值说明USERID只能为数字,英文字母和下划线.长度 过32个字符是无需要暂停的用户的登录名FEE最多 2 位小数是无预存待扣款金额,：元TXID只能为数字，英文字母和下划线，区分大小写，长度必须大于 1，且不超过 32 个字符否无预存待扣款操作的唯一标识。用法和 PAY 命令相同。(1)说明恢复一个被暂停的用户。(2)服务端版本要求RESUMEUSER 命令从 SAM 3.1-4127-SP3 开始支持。(3

15、)参数说明(4)返回类型SUC;用户资料变更 MODUSERMODUSER:ATTR1=”VALUE1”,ATTR2=”VALUE2”.ATTRn=”VALUEn”;示例:MODUSER:USERID=”test”,PASSWORD=”111”;(1)说明修改用户资料,除了必需信息,其他信息可选,未设置的属性将保持原有信息不变.例如,示例中的命令仅将用户 test 的修改为 111,其他信息都保持不变.(2)服务端版本要求参数 BACLNAME、SELFSERVICEPRIVILEGE 从 SAM3.13 版本开始支持。参数 AUTOLOGICDESTROYTIME 从SAM3.13SP5 版

16、本开始支持。(3)参数说明名称输入限制是否 必需默 认值说明USERID只能为数字,英文字母和下划线.长度 过32 个字符是无需要修改的用户的登录名PASSWORD只能为数字和英文字母,不能超过 16 个字符否用户名称输入限制是否必需默认值说明USERID只能为数字,英文字母和下划线.长度 过32个字符是无需要恢复的用户的登录名USERNAME过 32 个字符否用户真实USERGROUPNAME必需是SAM 系统中的用户组名否用户所属的用户组,如果不设置这个属性,保持原有用户组不变ATNAME必需是SAM 系统中的用户模板名称否无用户模板名称,如果仅设 置 了 USERGROUPNAME,而

17、没 有 设 置 ATNAME, 用户的 用户模板将保持原有用户模板不变PACKAGENAME必需是SAM 系统中的用户套餐名称否无用户套餐名称SEX0 ,1 ,2否用户0-无选择1-男2-女FREEAUTHEN1,2否是否免认证1-认证用户2-免认证用户CERTTYPE0,1,2,3,4否证件类型0-无选择56 学生证7 军官证8 护照CERTNO只能为数字,英文字母和下划线.长度 过32 个字符否证件号码EDU0,1,2,3,4,5,6,7否学历无选择小学初中高中专科本科67博士ADDRESS过 64 个字符否地址TCODE6 位数字否只能是数字和”-“号,过 32 个字符否号码MOBILE

18、只能是数字和”-“号,过 32 个字符否移动合法的地址,过 64 个字符否地址USERIP合法的 IP 地址否用户 IP 地址USERMAC合法的 MAC 地址否用户 MAC 地址NASIP合法的 IP 地址否NAS IPNASPORT不超过 4 位数的整数否NAS 端口AUTHORIP合法的 IP 地址否下传给用户的 IPFILTERID不超过 250 个字符否控制LOGININFO不超过 128 个字符否用户登录信息USRIVILEGE正整数否用户权限0 表示不下传USERVLAN不超过 4 位数的整数否用户下传 VLAN,0 表示不下传BACLNAME必须是 SAM 系统中的BACL 名

19、称否无用户的 BACLSELFSERVPERM必须是SAM 系统中的自助权限名称否所 有自 助权限用户所具备的自助权限。AUTOLOGICDESTROYTIME格式必须为合法的日期格否无用户自动预销户时间(4) 返回类型SUC;用户销户 DELUSERDELUSER:USERID=”userid”;实例:DELUSER:USERID=”test”;(1)说明用户销户(2)参数说明(3)返回类型SUC;用户预销户 LOGICDELUSERLOGICDELUSER:USERID=”userid”;实例: LOGICDELUSER:USERID=”test”;名称输入限制是否必需默认值说明USERI

20、D只能为数字,英文字母和下划线.长度不能超过 32 个字符是无需要销户的用户的登录名式：yyyy-mm-ddTYPE格式必须是数字，取值范围是 0,1否0Type 属性只有在： ATNAME ： 未修改 PACKAGENAME ：修改并且是周期 - 非周 期 周期 - 周期时生效0：立即生效1：下周期生效(1)说明用户预销户(2)服务端版本要求此接口从SAM3.13SP5 版本开始支持。(3)参数说明(4)返回类型SUC;用户信息查询 QUERYUSERQUERYUSER:USERID=”userid”;示例:QUERYUSER:USERID=”test”;(1)说明查询用户的详细信息(2)服

21、务端版本要求返回参数 PERIODLIMITTIME、NEXTBILLINGTIME 两个属性从SAM 3.1-4127-SP3 开始支持。返回参数SEFLAG、BACLNAME、SELFSERVICEPRIVILEGE 从 SAM3.13 版本开始支持。返回参数AUTOLOGICDESTROYTIME 从 SAM3.13SP5 版本开始支持。(3)参数说明(4)返回类型名称输入限制是否必需默认值说明USERID只能为数字,英文字母和下划线.长度过 32 个字符是无需要查询的用户的登录名名称输入限制是否必需默认值说明USERID只能为数字,英文字母和下划线.长度不能超过 32 个字符是无需要预

22、销户的用户的登录名ACK;(5) 返回参数名称说明USERID用户登录名USERNAME用户真实USERGROUPNAME用户所属的用户组ATNAME用户模板名称PACKAGENAME用户套餐名称SEX用户0-无选择1-男2-女FREEAUTHEN是否免认证1-认证用户2-免认证用户CERTTYPE证件类型0-无选择1-2-学生证军官证护照CERTNO证件号码EDU学历无选择小学初中高中专科5本科67博士ADDRESS地址TCODE号码MOBILE移动地址USERIP用户 IP 地址USERMAC用户 MAC 地址NASIPNAS IPNASPORTNAS 端口AUTHORIP下传给用户的 I

23、PFILTERID控制LOGININFO用户登录信息USRIVILEGE用户权限0 表示不下传USERVLAN用户下传VLAN,0 表示不下传PERIODLIMITTIME可用截止日期。格式为“2005-06-23”时间。只对使用周期类计费策略的用户有效，非周期计费策略的用户不返回此属性。NEXTBILLINGTIME下次记账时间点。格式为“2005-06-23”时间。只对使用周期类计费策略的用户有效，非周期计费策略的用户不返回此属性。SEFLAG用户状态。用户处于暂停状态用户处于正常状态3255保留BACLNAME用户 BACL 的名称SELFSERVPERM用户自助权限的名称AUTOLOG

24、ICDESTROYTIME用户自动预销户时间上网明细查询 QUERYARQUERYAR:ATTR1=”VALUE1”,ATTR2=”VALUE2”ATTRn=”VALUEn”;实例:QUERYAR:USERID=”test”;(1)说明查询某个用户的上网明细(2)参数说明(3)返回类型ACK; (返回数限制为最多 10000 条)(4)返回参数名称说明USERID用户登录名USERIP用户 IPUSERMAC用户 MACNASIPNAS IP名称输入限制是否 必需默认值说明USERID只能为数字, 英文字母和下划线. 长度过 32 个字符是无需要查询的用户的登录名FROMEDATE形 式 为

25、”2005-06-23 11:12:11”的时间否无表示查询上线时间在这个时间之后的上网 .例如,假设这个值为 2005-06-01,则表示查询上线时间在 2004-06-01 以后的上网 .如果为空,则没有限制上线时间TODATE形 式 为 ”2005-06-23 11:12:11”的时间否无表示查询下线时间在这个时间之前的上网 .例如,假设这个值为 2005-06-01,则表示查询下线时间在 2004-06-01 以前的上网 .如果为空,则没有限制下线时间查询认证失败日志 QUERYLOGINFAILLOGQUERYLOGINFAILLOG:ATTR1=”VALUE1”,ATTR2=”VA

26、LUE2”ATTRn=”VALUEn”;示例: QUERYAR:USERID=”test”;(1)说明查询某个用户认证失败的原因.(2)参数说明(3)返回类型ACK; (返回数限制为最多 1000 条)名称输入限制是否必需默认值说明USERID只能为数字,英文字母和下划线.长度 过 32个字符是无需要查询的用户的登录名FROMDATE形 式 为 ”2005-06-23 11:12:11”的时间否无表示查询认证时间在这个时间之后的认证失败日志.例如,假设这个值为 2005-06-01, 则查询 2005-06-01 以后的认证失败日志.如果为空,则没有这个限制.TODATE形 式 为 ”2005

27、-06-23 11:12:11”的时间否无表示查询认证时间在这个时间之前的认证失败日志.例如,假设这个值为 2005-06-01, 则查询 2005-06-01 以前的认证失败日志.如果为空,则没有这个限制.NASPORTNAS 端口ACCTSTART上线时间,格式为”2005-02-12 11:12:11”ACCTSTOP下线时间, 格式为”2005-02-12 11:12:11”ACCTTIME时长,秒INPUTBYTES流入流量,MBOUTPUTBYTES流出流量,MB(4) 返回参数验证用户VERIFYPASSWORDVERIFYPASSWORD:USERID=”,PASSWORD=”

28、;示例: VERIFYPASSWORD:USERID=”test”,PASSWORD=”111”;(1)说明校验该用户的是否正确.(2)参数说明(3)返回类型SUC;加密 GETENCRYPTPASSWORDGETENCRYPTPASSWORD:PASSWORD=”实例: GETENCRYPTPASSWORD:PASSWORD=”111”;(1) 说明对传来的 PASSWORD 进行加密,并将加密结果返回(2) 参数说明名称输入限制是 否必需默认值说明USERID只能为数字,英文字母和下划线.长度 过 32 个字符是无需要进行校验的用户的登录名PASSWORD是无需要校验的用户名称说明LOGT

29、IME认证时间MSG认证失败原因等.形式如下: 认证失败. 交换机:192.168.0.202 交换机端口:0 用 户名:test00000001 IP:192.168.0.2 MAC:00d0f8c0a800 原因:用户错误!(3) 返回类型ACK;(4) 返回参数用户REGUSERREGUSER: ATTR1=”VALUE1”,ATTR2=”VALUE2”.ATTRn=”VALUEn”;示例:REGUSER:USERID=”test”,USERNAME=”,PASSWORD=”111”;(1) 说明自助服务的用户接口,用户需要审核通过后才能正式成为 sam 系统的用户.(2) 参数说明名称

30、输入限制是否必需默认值说明USERID只能为数字,英文字母和下划线.长度 过 32 个字符是无用户登录名PASSWORD只能为数字和英文字母,过 16 个字符是无用户USERNAME过 32 个字符是无用户真实SEX0 ,1 ,2否0用户0-无选择名称说明ENCRYPTPASSWORD加密后的名称输入限制是否必 需默认值说明PASSWORD只能为数字和英文字母,过16 个字符是无需要加密的用户1-男2-女CERTTYPE0,1,2,3,4否0证件类型0-无选择1-学生证军官证护照CERTNO只能为数字,英文字母和下划线.长度 过 32 个字符否无证件号码EDU0,1,2,3,4,5,6,7否无

31、学历无选择小学初中高中专科本科67博士ADDRESS过 64 个字符否无地址TCODE6 位数字否无只 能 位 数 字和”-“ 号,过 32 个字符否无号码MOBILE只 能 位 数 字和”-“ 号,过 32 个字符否无移动合法的地址,过 64否无地址(3) 返回类型SUC;账户信息查询 QUERYACCOUNTINFOQUERYACCOUNTINFO:USERID=”实例: QUERYACCOUNTINFO:USERID=”user01”;(1)说明根据传来的用户 ID 查询并返回账户信息。(2)参数说明(3)返回类型ACK;(4)返回参数名称说明ACCOUNTID账户 IDACCOUNTS

32、E账户状态。1：正常，2：透支，3：欠费ACCOUNTFEE账户余额，：元PREACCOUNTFEE账户预存待扣款余额，：元名称输入限制是否必需默认值说明USERID有效的用户 ID是无个字符USERIP合法的 IP 地址否无用户 IP 地址USERMAC合法的 MAC 地址否无用户 MAC 地址LOGININFO不超过 128 个字符否无用户登录信息MEMO不超过 128 个字符否无备注根据证件号查询用户信息 QUERYUSERBYCERTNOQUERYUSERBYCERTNO:CERTNO=”实例: QUERYUSERBYCERTNO:CERTNO=”1223112”;(1)说明根据传来的

33、证件号码查询并返回用户信息。(2)参数说明(3)返回类型ACK;(4)返回参数和用户信息查询 QUERYUSER 返回相同用户缴费并返回账户信息 FUNDFUND: USERID=”userid”,FEE=”x” ,TXID=”yyyyyyyy”;实例: FUND: USERID=”test”,FEE=”100”,TXID=”10001”(1)说明根据传来的用户 ID 查询并返回账户信息。(2)服务端版本要求TXID 参数在SAM 3.1-4127-SP3 及以上版本才支持。(3)参数说明名称输入限制是否 必需默认值说明USERID有效的用户 ID是无需要缴费的用户的登录名FEE最多 2 位小

34、数是无缴费金额,”元”名称输入限制是否必需默认值说明CERTNO证件号是无(4) 返回类型ACK;(5) 返回参数和 QUERYACCOUNTINFO 相同。用户退款并返回账户信息 REFUNDREFUND: USERID=”userid”,FEE=”x” ,TXID=”yyyyyyyy”;实例: REFUND: USERID=”test”,FEE=”100”,TXID=”10001”;(1)说明根据传来的用户 ID 查询并返回账户信息。(2)服务端版本要求TXID 参数在AM 3.1-4127-SP3 及以上版本才支持。(3)参数说明(4)返回类型ACK;(5)返回参数和 QUERYACCO

35、UNTINFO 相同。名称输入限制是否必需默认值说明USERID有效的用户 ID是无FEE最多 2 位小数是无退款金额,”元”TXID只能为数字，英文字母和下划线，区分大小写，长度必须大于 1，且不超过 32 个字符否无退款操作的唯一标识。用法和 PAY 命令相同。TXID只能为数字，英文字母和下划线，区分大小写，长度必须大于 1，且不超过 32 个字符否无缴费操作的唯一标识。用法和 PAY 命令相同。创建 TXIDNEWTXIDNEWTXID:;示例: NEWTXID:;(1)说明返回一个 TXID。TXID 永不重复，每次调用 NEWTXID 命令均返回一个新的TXID。(2)服务端版本要

36、求NEWTXID 命令在 AM 3.1-4127-SP3 及以上版本才支持。(3)参数说明无。(4)返回类型ACK;(5)返回参数检测用户是否QUERYONLINESEQUEYRONLINESE:USERID=”userid”;示例: QUERYONLINESE:USERID=”test”;(1)说明查询用户是否。(2)服务端版本要求QUERYONLINESE 命令从SAM3.13 版本开始支持。(3)参数说明名称说明TXID返回的 TXID，只能为数字，英文字母和下划线，区分大小写，长度必须大于 1，且不超过 32 个字符(4) 返回类型ACK;(5) 返回参数强制用户下线 KICKONLI

37、NEUSERKICKONLINEUSER:USERID=”,DELETEFLAG=”.”,BLACKLISTFLAG=”,BLACKLISTEXPIRETIME =”, BLACKLISTMSG=”;示例: KICKONLINEUSER:USERID=”test”;(1)说明强制用户下线，并返回操作是否成功。如果用户当前处于不状态，返回错误：ERR:用户不！。强制用户下线时可以选择是否把用户加入，见参数 BLACKLISTFLAG。在强制用户下线后，如果要继续处理该用户的业务，建议使用 QUERYONLINESE 确认用户已经处于不状态后再继续处理。(2)服务端版本要求KICKONLINEUS

38、ER 命令从SAM3.13 版本开始支持。(3)参数说明名称输入限制是否 必需默 认值说明名称说明ONLINESE用户状态。12不名称输入限制是否必需默认值说明USERID只能为数字,英文字母和下划线.长度过 32 个字符是无需要查询的用户的登录名(4) 返回类型SUC;解除用户绑定 UNBINDUNBIND:USERID=”userid”;实例: UNBIND:USERID=”test”;(5)说明给一个用户解除所有绑定(6)服务端版本要求SAM 3.44 BUILD 10854 及以后版本(7)参数说明(8)返回类型SUC;名称输入限制是否必需默认值说明USERID只能为数字,英文字母和下

39、划线.长度 过32个字符是无需要解除绑定的用户的登录名USERID只能为数字,英文字母和下划线. 长度过 32 个字符是无需要强制下线的用户的登录名BLACKLISTFLAG1,2否2是否把用户加入。1加2不加BLACKLISTEXPIRETIME1-1440否5有效期，：分钟。BLACKLISTMSG不超过 250 字符否用 户处 于黑 名单中!提示信息。网关流量查询 QUERYNTDFLOWQUERYNTDFLOW:ATTR1=”VALUE1”,ATTR2=”VALUE2”ATTRn=”VALUEn”;实例: QUERYNTDFLOW:USERID=”test”;(1)说明查询某个用户的网

40、关流量使用情况(2)参数说明(3)返回类型ACK; (返回数限制为最多 10000 条)(4)返回参数名称说明USERID用户登录名USERIP用户 IPNTDIP网关设备 IPv4STARTTIME开始时间名称输入限制是否 必需默认值说明USERID只能为数字, 英文字母和下划线. 长度过 32 个字符是无需要查询的用户的登录名FROMEDATE形 式 为 ”2005-06-23 11:12:11”的时间否无表示查询网关流量 生成时间在这个时间之后的网关流量 .例如,假设这个值为 2005-06-01,则表示查询生成时间在 2004-06-01以后的网关流量 .如果为空,则没有限制网关流量

41、生成的开始时间TODATE形 式 为 ”2005-06-23 11:12:11”的时间否无表示网关流量 生成时间时间在这个时间之前的网关流量 .例如,假设这个值为 2005-06-01,则表示生成时间在 2004-06-01 以前的网关流量 .如果为空,则没有网关流量 生成的结束时间帐务流水查询 QUERYACCOUNTFLOWQUERYACCOUNTFLOW:ATTR1=”VALUE1”,ATTR2=”VALUE2”ATTRn=”VALUEn”;实例: QUERYACCOUNTFLOW:USERID=”test”;(5) 说明查询某个用户的帐务流水情况(6) 参数说明名称输入限制是否 必需默

42、认值说明USERID只能为数字, 英文字母和下划线. 长度过 32 个字符是无需要查询的用户的登录名FROMEDATE形 式 为 ”2005-06-23 11:12:11”的时间否无表示查询帐务流水 生成时间在这个时间之后的帐务流水 .例如,假设这个值为 2005-06-01,则表示查询生成时间在 2004-06-01以后的帐务流水 .如果为空,则没有限制帐务流水 生成的开始时间ENDTIME结束时间FOREIGNUPFLOW国际上行流量FOREIGNDOWNFLOW国际下行流量INLANDUPFLOW国内上行流量INLANDDOWNFLOW国内下行流量CUSUPFLOW网关内上行流量CUSU

43、PDOWNFLOW网关内下行流量FLOWSUM网关总流量ACCTCAUSE原因ACCTFLOWFLAG是否有对应的账务流水CREATETIME生成时间(7) 返回类型ACK; (返回数限制为最多 10000 条)(8) 返回参数名称说明USERID用户登录名TODATE形 式 为 ”2005-06-23 11:12:11”的时间否无表示帐务流水 生成时间时间在这个时间之前的帐务流水 .例如,假设这个值为 2005-06-01,则表示生成时间在 2004-06-01 以前的帐务流水 .如果为空,则没有帐务流水 生成的结束时间CHARGETYPE数值类型否无表示：帐务流水的计费来源数值及其对应的含

44、义时长扣费端口流量扣费27 网关总流量扣费国内上行流量扣费国内下行流量扣费国际上行流量扣费国际下行流量扣费周期扣费费缴费23 预存待扣款14 退款转账入款转账出款余额充值待扣款充值26 自助余额充值28 自助待扣款充值手工登账入款手工登账出款充值卡登账入款充值卡登账出款25 自助开通24 待扣款划出1931 周期补偿ACCOUNTID帐户名SERVICEID接入控制CHARGETYPE计费来源ACSTYPE接入方式BEGIME记账起始时间CREATETIME生成时间ISBILLOUNT已合帐ISWRITEOFF已销账DESTROYTIME销账时间DESTROYTYPE销账类型FEE费用BADBILLFEE坏账金额ODDFEE网关流量补差额(元)ACCOUNTFEE当前余额(元