API 接口调用帮助说明
点击查看 API 接口调用例子Demo参考

点击查看 API接口调用测试工具


说明:

UserLoginStr登陆获取到Token只需要一次获取,多台设备可以用同一个Token调用做任务,Token可以一直用于做多次项目任务,不要每做完一个项目任务等就重新登陆获取新Token,除非是接口返回之前Token失效了。


其他没列出说明的接口函数调用跟下面说明接口函数调用格式是统一完全一样的:http://分配接口IP:9180/service.asmx/接口函数名称?函数参数1=传递参数值1&函数参数2=传递参数值2&....


  简单对接操作流程如下: 




(流程备注:如果在使用GetYzmStr函数获取接收到短信或语音验证码时,像网络丢包或程序处理异常出错等情况下,可以使用GetYzmLogStr再次来获取丢失验证码。)



1.调用UserLoginStr登陆

2.调用GetHMStr接口获取号码

   说明:当接口返回Id=**** 时,表示系统繁忙等待分配号码中,需要间隔2-10秒调用GetTaskStr接口查询到分配号码,如返回失败标识重新开始GetYzmStr获取号码。

3.获取到号码后,调用GetYzmStr 查询获取接收短信信息,可间隔2-10秒循环调用查询到接收短信为止,用户可以自己设置个超过时限,在超过时限内还没有接收短信获取到就调用sfHmStr接口释放这个号码,再调用GetYzmStr接口获取新号码。

(备注:超时时限建议根据项目实际要求输入限制时间定,如果项目限制要在60秒内必须要输入验证码,可设置在到40秒内还没验证码返回就超时,如项目限制要120秒内必须要输入验证码,可设置在到100秒还没验证码返回超时这样类似方式。)

4.完成任务或号码不要了,调用sfHmStr接口释放号码(不释放号码会占用号码超量不能获取新号)

 

一个号码同时并发做多个不同项目任务的操作流程:

1.先用第一个项目调用GetHMStr获取到号码。

2.再用获取到号码调用mkHMStr接口指定号码同时做剩下的其他项目任务。

3.多次调用GetYzmStr 查询获取多个项目的接收短信信息。

例如:要做1001,38这2个项目Id任务,先用其中一个项目Id用GetHMStr获取分配到号码13088888888,然后再用mkMHStr接口指定号码13088888888做剩下的38项目Id任务,最后用GetYzmStr传递自己项目Id去获取自己项目对应的验证码。



一个号码同时并发做语音或短信多个不同混合项目任务的操作流程:

1.必须先用语音项目调用GetHMStr获取到号码,这样系统才能分配到能做语音的号码。(备注:如果先用短信项目调用GetHMStr获取到号码,有可能该号码只能做短信项目,做语音项目失效不会有验证码返回的)

2.再用获取到号码调用mkHMStr接口指定号码同时做剩下的其他项目任务。

3.多次调用GetYzmStr 查询获取多个项目的接收短信信息。

例如:要做语音项目30001,和短信项目38这2个项目Id任务,必须要用语音项目Id用GetHMStr去获取分配号码,如分配到13088888888号码,然后再用mkMHStr接口指定号码13088888888做剩下的短信38项目Id任务,最后用GetYzmStr传递自己项目Id去获取自己项目对应的验证码。



API接口调用:接口函数名称请区分大小写,建议每次调用接口时传递的数据及调用接口完成返回的数据,及操作时间戳都保存成一个Txt日志文件,这样以后API接口调用出问题查看Txt日志文件就能清楚找到原因 。

以下接口调用例子 string类型 是字符串类型值 ,int 是数字型值,请不要搞错了。




一、UserLoginStr 登陆接口调用
接口说明:登陆帐号获取Token。
参数 类型 说明 备注
name string 帐户名
psw string 密码 支持使用明文或MD5加密大写

返回值:string 字符串  
返回值 说明 备注
字符长度32 登陆token 调用接口成功,返回登陆token
空值 调用接口超时异常
0 帐户处于禁止使用状态
-1 调用接口失败
-2 帐户信息错误 调用的参数有为空值
-3 用户或密码错误 用户名或密码错误
-4 不是普通帐户
该帐户不能用于Web Service或HTTP 等API接口模式(如:代理帐户,软件作者,客服,技术员,系统管理员等)

注:只有普通用户才能使用Web Service 或http接口
-30 非绑定IP 访问IP非法

例如接口地址:http://分配接口IP:9180/service.asmx  查看调用方式,可点击网页的“UserLoginStr”连接查看
Http Get 调用方式:http://分配接口IP:9180/service.asmx/UserLoginStr?name=帐户名&psw=密码

如帐户名称:fjs 密码:123456 调用接口登陆
http://分配接口IP:9180/service.asmx/UserLoginStr?name=fjs&psw=123456

正常返回32位token值如:2632120F90A971D9FB4771D97D507BFD



二、UserExitStr 退出登陆接口调用
接口说明:下线退出登陆帐号
参数 类型 说明 备注
token string UserLoginStr登陆成功时接口返回的token

返回值:string 字符串  
返回值 说明 备注
1 退出成功 调用接口成功
空值 调用接口超时异常
0 退出失败

例如接口地址:http://分配接口IP:9180/service.asmx  查看调用方式,可点击网页的“UserExitStr”连接查看
Http Get 调用方式:http://分配接口IP:9180/service.asmx/UserExitStr?token=string



三、UpdatePswStr 修改登陆密码接口调用
接口说明:更改帐号密码。
参数 类型 说明 备注
name string 帐户名
oldpsw string 旧密码
newpsw string 新密码

返回值:int 数字型  
返回值 说明 备注
1 修改密码成功
-1 修改密码失败
其他值 参考UserLoginStr()返回值说明

例如接口地址:http://分配接口IP:9180/service.asmx  查看调用方式,可点击网页的“UpdatePswStr”连接查看
Http Get 调用方式:http://分配接口IP:9180/service.asmx/UpdatePswStr?name=string&oldpsw=string&newpsw=string



四、GetBalanceStr 获取户帐户余额接口调用
接口说明:获取帐号余额相关信息。
参数 类型 说明 备注
name string 帐户名
psw string 密码 支持使用明文或MD5加密大写

返回值: string 字符串  
返回值 说明 备注
>=0 帐户余额 返回值大于或等于0时是帐户当前余额
其他值 参考UserLogin()返回值说明


例如接口地址:http://分配接口IP:9180/service.asmx  查看调用方式,可点击网页的“GetBalanceStr”连接查看
Http Get 调用方式:http://分配接口IP:9180/service.asmx/GetBalanceStr?name=string&psw=string
 

 


五、GetXMStr 获取收藏项目数据接口调用
接口说明:获取收藏项目数据
参数 类型 说明 备注
token string 登陆token

返回值:string 字符串  
返回值 说明 备注
字符长度大于10 返回项目数据  

单个项目里用“|,|”分隔数据属性项,多个项目用“|;|”分隔多个不同项目数据

单个项目:项目编码|,|项目名称|,|项目单价|,|类型

多个项目:

项目编码|,|项目名称|,|项目单价|,|类型|;|项目编码|,|项目名称|,|项目单价|,|类型|;|项目编码|,|项目名称|,|项目单价|,|类型

 

空值 调用接口超时异常
0 没登陆或失败

例如接口地址:http://分配接口IP:9180/service.asmx  查看调用方式,可点击网页的“GetXMStr”连接查看
Http Get 调用方式:http://分配接口IP:9180/service.asmx/GetXMStr?token=string
 

正常返回值如:1|,|陌陌注册|,|0.30|;|2|,|微信注册|,|0.30

 

 

六、GetAreaStr 获取省份数据接口调用
接口说明:获取省份数据
参数 类型 说明 备注
   

返回值:string 字符串  
返回值 说明 备注
字符长度大于10 返回项目数据

多个省份用半角逗号分隔

空值 调用接口超时异常

例如接口地址:http://分配接口IP:9180/service.asmx  查看调用方式,可点击网页的“GetXMStr”连接查看
Http Get 调用方式:http://分配接口IP:9180/service.asmx/GetAreaStr

正常返回值如:安徽,北京,福建,甘肃,广东,广西,贵州,海南,河北,河南,黑龙江,湖北,湖南,吉林,江苏,江西,辽宁,内蒙古,宁夏,青海,山东,山西,陕西,上海,四川,天津,西藏,新疆,云南,浙江,重庆,外国

 

七、GetAreaSubStr 获取指定省份下每个城市数据接口调用
接口说明: 获取指定省份下每个城市数据
参数 类型 说明 备注
area string 省份  

参数值需要使用utf-8编码

如“广东”utf-8编码是:%E5%B9%BF%E4%B8%9C

 


返回值:string 字符串  
返回值 说明 备注
字符长度大于10 返回项目数据

多个城市用半角逗号分隔

空值 调用接口超时异常

例如接口地址:http://分配接口IP:9180/service.asmx  查看调用方式,可点击网页的“GetXMStr”连接查看
Http Get 调用方式:http://分配接口IP:9180/service.asmx/GetAreaSubStr?area=string

例:获取广东省每个城市名称 http://分配接口IP:9180/service.asmx/GetAreaSubStr?area=%E5%B9%BF%E4%B8%9C

正常返回值如:江门,东莞,惠州,珠海,广州,汕尾,揭阳,肇庆,云浮,河源,清远,汕头,中山,梅州,阳江,湛江,佛山,韶关,深圳,茂名,潮州

 

八、GetHM2Str  获取号码接口调用
接口说明:获取分配可做指定项目编码任务的号码。
参数 类型 说明 备注
token string 登陆token
xmid int 项目编码 要获取号码的项目编码
sl int
获取号码数量,单个号码填1

平台支持一次获取多个号码,如一次需要获取30个可做项目的号码,把获取号码数量参数值设置为 sl=30
 

获取号码数量不能超过帐户可同时获取最大号码数量

 

lx int  

要获取号码类型,0是不限运营商,1是移动号码,2是联通号码,3是电信号码

 

 lx=0是不限运营商,1是移动号码,2是联通号码,3是电信号码,4是外国号码,130到189 是指定只获取指定号段,如:lx=136 是指定只获取分配136号码
a1 string 省份 
参数值为空时表示不限地区,有字符时使用utf-8编码,如“广东”utf-8编码是:%e5%b9%bf%e4%b8%9c

a2 string 城市  

参数值为空时表示不限城市,有字符时使用utf-8编码,如“广东”utf-8编码是:%e5%b9%bf%e4%b8%9c

 

pk string 专属卡商对应编号  

非专属对应时该参数值为空,不为空时只获取指定专属编号卡商提供号码

 

ks int 要获取指定卡商Id的号码 参数值不能空,如果不指定卡商可以为0
rj int 软件作者提成Id 参数值不能空,没作者Id可以为0
返回值:string 字符串  
返回值 说明 备注
hm=获取到号码 获取到号码数据,有多个号码用逗号分隔,  

如一次取3个号码返回:hm=137*******1,136*******2,137*******3

 

id=数值 返回获取号码任务Id数值,  

当返回数据包含id= 说明服务器繁忙不能即时分配号码,已经帮生个获取号码任务Id用来二次查询获取号码,可在延时1-30秒之后用这个任务Id值再次调用GetTaskStr接口函数获取分配的号码。

当接口返回值包含id=**** 时,说明服务器繁忙,不能再次调用该接口来重新获取号码,只能以返回任务Id使用GetTaskStr接口函数来获取号码完成一次号码获取任务操作

 

空值 调用接口超时异常
-1 当前没有合条件号码  
-2 提交取号任务超量,请稍后再试
-3
获取号码数量超量,请释放已经做完任务不使用的号码,以便获取新号码。、
-4 该项目已经被禁用,暂停取号做业务
-8 帐户余额不足  
-11 端口繁忙被占用,请稍后再试
-12 该项目不能以获取号码方式工作
特殊登陆验证项目只能用已经注册过号码指定号码使用,不能自动分配获取号码。

(备注:请禁止使用是别人已经注册过项目的号码进行指定号码的验证登陆,否则别人投诉将被封帐号不退款。)
-15 查找不到该专属对应KEY 卡商没有生成有该对应专属KEY,或专属KEY已经被卡商删除了
0 没登陆或失败

例如接口地址:http://分配接口IP:9180/service.asmx  查看调用方式,可点击网页的“GetHMStr”连接查看
Http Get 调用方式:http://分配接口IP:9180/service.asmx/GetHMStr?token=string&xmid=int&sl=int&lx=int&a1=string&a2=string&pk=string
 

正常即时返回号码如:hm=13012345678,13012345679

系统繁忙返回等待获取号码的任务Id如:id=12345

 

如要指定获取广东省广州市手机号码调用如下:

“广东”utf-8编码是:%e5%b9%bf%e4%b8%9c

“广州”utf-8编码是:%e5%b9%bf%e5%b7%9e

Http Get 调用方式:http://分配接口IP:9180/service.asmx/GetHMStr?token=string&xmid=int&sl=1&lx=0&a1=%e5%b9%bf%e4%b8%9c&a2=%e5%b9%bf%e5%b7%9e&pk=

 

如要指定获取广东省广州市手机电信运营商的号码调用如下:

Http Get 调用方式:http://分配接口IP:9180/service.asmx/GetHMStr?token=string&xmid=int&sl=1&lx=3&a1=%e5%b9%bf%e4%b8%9c&a2=%e5%b9%bf%e5%b7%9e&pk=

如会话Token是2632120F90A971D9FB4771D97D507BFD,项目编号是:2 的微信项目,需要获取一个号码做任务

http://分配接口IP:9180/service.asmx/GetHMStr?token=2632120F90A971D9FB4771D97D507BFD&xmid=2&sl=1&lx=3&a1=&a2=&pk=

接口调用成功返回:id=任务Id(数值) 或 hm=手机号码 这2种标识,返回其他标识是调用接口获取号码失败

 

 

九、GetTaskStr  通过任务Id获取号码接口调用
接口说明:通过任务Id来获取号码。
参数 类型 说明 备注
token string 登陆token
id int 任务Id  

该Id数值是在GetHM2Str获取号码接口函数时返回的任务Id数值

 

返回值:string 字符串  
返回值 说明 备注
字符长度大于10 获取到号码数据  

当返回有多个号码时,多个号码用逗号分隔。

 

空值 调用接口超时异常
1 任务Id还在等待分配号码中 可延时1-30秒后再次调用该任务接口获取号码
0 没登陆或失败
-1 任务已结束或被已被中止或当前没有合条件号码  

该任务Id已经失效,可以重新通过GetHMStr接口获取号码

 

-11 端口繁忙被占用,请稍后再试

例如接口地址:http://分配接口IP:9180/service.asmx  查看调用方式,可点击网页的“GetTaskStr”连接查看
Http Get 调用方式:http://分配接口IP:9180/service.asmx/GetTaskStr?token=string&id=int

正常即时返回号码如:13012345678,13012345679

 

十、GetYzmStr  获取接收验证码短信接口调用
接口说明:获取号码接收到验证码信息。
参数 类型 说明 备注
token string 登陆token
hm string 号码  
xmid int 项目编码  

当该项目是多次接收时,可以间隔延时1-30秒重复调用获取验证码到完成项目任务

 

返回值:string 字符串  
返回值 说明 备注
字符长度大于6 获取到验证码信息
当项目是语音验证码时,返回验证信息还带有语音原始文件的访问地址,http://***.wav
空值 调用接口超时异常
获取验证码数据时异常或数据丢包了,可能再次通过GetYzmLogStr接口函数重试获取该验证码
1 卡商还没接收到验证信息,等待返回验证码信息  

可延时间隔1-30秒后再次调用该任务接口再次获取验证码短信,直到获取到为止。

建议用户也可以根据情况定义个超时时间段如2分钟,在超过这个限定时间段后还没获取到验证码信息,当该号码无效释放注销该号码,重新获取过新号码进行任务。

 

0 没登陆或失败
-1 该号码已经已经被卡商注销。  
-2 业务已被取消,可重试重新操作语音验证
-3 业务异常中止
-8 余额不足扣费  
-9 专属数据出错

例如接口地址:http://分配接口IP:9180/service.asmx  查看调用方式,可点击网页的“GetYzmStr”连接查看
Http Get 调用方式:http://分配接口IP:9180/service.asmx/GetYzmStr?token=string&hm=string&xmid=int

正常即时验证码信息如:【陌陌科技】671579陌陌验证码,仅用于注册,请勿告知他人。客服电话028-62836666
 

注:当使用GetYzmStr接口获取任务验证码异常各数据丢包时,可以使用下面的GetYzmLogStr接口函数重试获取。

 

十一、GetYzmLogStr 重试获取验证码接口调用

接口说明:当获取验证码接口GetYzmStr调用超时或出错时丢失验证码数据时,使用该接口重试获取,该接口函数只有在GetYzmStr接口异常出错或数据丢包时才使用。
参数 类型 说明 备注
token string 登陆token
hm string 号码  
xmid int 项目编码  

 

 

返回值:string 字符串  
返回值 说明 备注
字符长度大于6 获取到验证码信息
当项目是语音验证码时,返回验证信息还带有语音原始文件的访问地址,http://***.wav
空值 调用接口超时异常
获取验证码数据时异常或数据丢包了,可能再次通过GetYzmLogStr接口函数重试获取该验证码
1 卡商还没接收到验证信息,等待返回验证码信息  

 当重试获取验证码接口返回1时,表示任务还在继续等待卡端返回验证码的正常状态,之后可以用回GetYzmStr接口函数继续扫描接口获取到验证码为止。

 

0 没登陆或失败
-1 该号码已经已经被卡商注销。  
-2 业务已被取消,可重试重新操作语音验证
-3 业务异常中止
-8 余额不足扣费  

例如接口地址:http://分配接口IP:9180/service.asmx  查看调用方式,可点击网页的“GetYzmLogStr”连接查看
Http Get 调用方式:http://分配接口IP:9180/service.asmx/GetYzmLogStr?token=string&hm=string&xmid=in



 

 

十二、SendSms2Str 发送信息接口调用

接口说明:发送短信数据。
参数 类型 说明 备注
token string 登陆token
xmid int 项目编码  
hm string 发送信息号码  
nr string 短信内容,短信不能过70字数的长度  

短信内容要使用UTF-8 URL转码,否则中文内容会是乱码信息。参考编码是否正常,请在自己的程序里测试下使用UTF-8编码“中文”这2个字,正确的utf-8编码后是“%e4%b8%ad%e6%96%87”,如果程序编码结果不同说明程序编码有问题了,需要修改下你的程序编码代码。

 

pk string 专属对接KEY 如果不是专属对接,该参数值为空

返回值:int 数值 
返回值 说明 备注
1 提交发送信息成功  
0 没登陆
-1 发送失败
-2 该项目不能进行短信发送的  
-3 项目编码错误  
-4 该号码已经已经被卡商注销 该号码当前已经不在线可用
-5 发送短信内容为空
-6 短信内容过长 内容字数长度超过70
-7 发送号码为空或非正常号码
-8 余额不足
-9 接收数据失败
-10 项目对应发送端口没设置好,需要联系客服修改项目配置
-11 专属项目信息错误
-12 专属项目定义重复


例如接口地址:http://分配接口IP:9180/service.asmx  查看调用方式,可点击网页的“SendSmsStr”连接查看
Http Get 调用方式:http://分配接口IP:9180/service.asmx/SendSmsStr?token=string&xmid=int&hm=string&nr=string&pk=string

注意:nr内容信息要使用UTF-8 URL转码






十三、GetFsState  反馈发送状态回执报告接口调用
接口说明:反馈发送状态回执报告,确认短信发送成功还是失败。
参数 类型 说明 备注
token string 登陆token
hm string 号码  
xmid int 项目编码  
返回值:string字符串  
返回值 说明 备注
1 号码还没反馈发送状态回执报告,继续间隔6-10秒调用等待反馈状态  

 

 

发功发送 短信已经成功发送出去
发送失败 短信已经发送失败,平台退回费用
空值 调用接口超时异常
0 没登陆或失败
其他值 请参考UserLoginStr()返回值说明  

例如接口地址:http://分配接口IP:9180/service.asmx  查看调用方式,可点击网页的“GetFsState”连接查看
Http Get 调用方式:http://分配接口IP:9180/service.asmx/GetFsState?token=string&hm=string&xmid=int




 
十四、sfHmStr  注销释放指定号码接口调用
接口说明:注销释放指定号码。
参数 类型 说明 备注
token string 登陆token
hm string 要释放号码  
返回值:string 字符串  
返回值 说明 备注
1 成功释放  
空值 调用接口超时异常
0 没登陆或失败
-1 释放号码失败  

例如接口地址:http://分配接口IP:9180/service.asmx  查看调用方式,可点击网页的“sfHmStr”连接查看
Http Get 调用方式:http://分配接口IP:9180/service.asmx/sfHmStr?token=string&hm=string



 


十五、sfAllStr  注销释放所有获取的号码接口调用
接口说明:注销释放所有获取的号码。
参数 类型 说明 备注
token string 登陆token
返回值:string 字符串  
返回值 说明 备注
1 成功释放  
空值 调用接口超时异常
0 没登陆或失败
-1 释放失败  

例如接口地址:http://分配接口IP:9180/service.asmx  查看调用方式,可点击网页的“sfAllStr”连接查看
Http Get 调用方式:http://分配接口IP:9180/service.asmx/sfAllStr?token=string


 


 

十六、HmdStr  增加黑名称号码接口调用
接口说明:获取号码接收到验证码信息。
参数 类型 说明 备注
token string 登陆token
hm string 号码  
xmid int 项目编码  
返回值:int数值  
返回值 说明 备注
1 增加黑名单成功  

 

 

空值 调用接口超时异常
0 没登陆或失败
-1 增加失败  
-2 号码黑名单已经存在,不需要重复增加

例如接口地址:http://分配接口IP:9180/service.asmx  查看调用方式,可点击网页的“HmdStr”连接查看
Http Get 调用方式:http://分配接口IP:9180/service.asmx/HmdStr?token=string&hm=string&xmid=int



 
十七、mkHMStr 指定号码做项目接口调用

接口说明: 使用指定号码做项目。
参数 类型 说明 备注
token string 登陆token
xmid int 项目编码  
hm string 指定号码  
op int 码库检测方式
0为检测云码库该号码是否已经做过该项目任务,防止做无效的项目任务。

1为不检测码库是否已经做过该项目,强制该号码做该项目任务,一般在解锁或取回密码等类似非注册的项目任务才指定不检测。


返回值:int 数值 
返回值 说明 备注
1 指定号码成功 成功后可GetYzmStr来取码
0 没登陆
-1 指定号码失败
-2 指定号码当前不在线  
-3 指定号码正在被锁定其他用户使用中  
-4 项目编码错误
-5 指定号码已经在做该项目任务,不能同时重复同一个项目
如果是语音项目,表示该号码已经有在做语音项目了,同一个号码不能同时做多个不同语音项目,一个号码只能同时做一个语音项目。
-8 余额不足
-9 指定号码卡商已经标识不能做发送项目任务
-10 该号码在云码库中检测到已经做过该项目任务 在码库检测方式op参数为0时才会可能有该返回值出现。
-11 专属对接数据异常
-12 该号码所属卡商已经标识不能做该项目任务了
-13 系统已经禁止该卡商号码做该项目任务
-15 专属项目单价设置异常
-16 指定号码不能指定做该项目 主要是WX项目检测为了防止自己获取注册过WX项目的号码被别人指定号码去登陆顶号盗了,如果指定号码做WX项目,在该号码已经在云码库检测做过,而且做过的帐户不是现指定帐户就会指定失败返回-16
(备注:请禁止使用别人已经注册过号码进行指定号码的验证登陆,否则别人投诉将被封帐号不退款。)
-20 号码不在线,但卡商语音设备在线时,可以尝试切卡上线 返回-20该标识表示可以尝试控制卡商卡池设备跳转切卡到指定号码
-30 指定号码不在线,但号码在卡池设备表中,可以尝试让卡池切卡定位到当前号码
-33 该号码还没成功上报,可能还在切卡处理中或已经切卡失败该号码不能再指定使用


例如接口地址:http://分配接口IP:9180/service.asmx  查看调用方式,可点击网页的“mkHMStr”连接查看
Http Get 调用方式:http://分配接口IP:9180/service.asmx/mkHMStr?token=string&xmid=int&hm=string&op=int
 

  

 


 
十八、mkLineStr 指定号码切卡上线

接口说明: 指定号码尝试切卡上线处理。
参数 类型 说明 备注
token string 登陆token
xmid int 项目编码  
hm string 指定号码  
op int 默认0

返回值:int 数值 
返回值 说明 备注
返回值>0 成功进入号码切卡上线流程,返回切卡处理任务单Id
任务单Id用来在mkTaskStr 接口获取卡池定位切卡号码的上线状态
0 没登陆
-1 指定号码切卡失败
-2 指定号码已经在等待切卡处理上线中,不能重复操作  
-3 切卡号码所在端口繁忙被占用,请稍后再试  
-4 项目编码错误
-5 号码定位不到卡商设备,不能控制卡池切卡换号。
-6 号码已经在线,不需要再切卡上线。
-8 余额不足
-9 指定号码卡商已经标识不能做发送项目任务
-10 该号码在云码库中检测到已经做过该项目任务 在码库检测方式op参数为0时才会可能有该返回值出现。


例如接口地址:http://分配接口IP:9180/service.asmx  查看调用方式,可点击网页的“mkLineStr”连接查看
Http Get 调用方式:http://分配接口IP:9180/service.asmx/mkLineStr?token=string&xmid=int&hm=string
 

 





 



 
十九、mkTaskStr 获取指定号码切卡上线的状态

接口说明: 指定号码切卡上线处理任务状态获取。
参数 类型 说明 备注
token string 登陆token
taskid int 切卡上线任务id mkLineStr 号码切卡时返回任务Id

返回值:int 数值 
返回值 说明 备注
2 号码已经在成功切卡定位上线,可以开始使用了。 号码切卡上线成功,并相当于mkHMStr使用了指定号码开始处理项目任务了。
1 号码还在切卡上线处理中,需要继续间隔3-10秒调用mkTaskStr查询号码切卡处理状态
0 没登陆
-1 切卡上线处理失败,任务被取消
-2 号码已经不能定位上线  
-3 当前卡池操作繁忙中  
-4 切卡上线锁卡中操作失败
-5 号码切卡上线后指定使用失败,请稍后再试


例如接口地址:http://分配接口IP:9180/service.asmx  查看调用方式,可点击网页的“mkTaskStr”连接查看
Http Get 调用方式:http://分配接口IP:9180/service.asmx/mkTaskStr?token=string&taskid=int
 

  




 

 
二十、mkTaskStr 指定号码切卡上线

接口说明: 指定号码切卡上线处理任务状态获取。
参数 类型 说明 备注
token string 登陆token
taskid int 切卡上线任务id  

返回值:int 数值 
返回值 说明 备注
2 号码已经在成功切卡定位上线,可以开始使用了。 号码切卡上线成功,并相当于指定使用了号码开始处理项目任务了。
1 号码还在切卡上线处理中,需要继续间隔3-10秒调用mkTaskStr查询号码切卡处理状态
0 没登陆
-1 切卡上线处理失败,任务被取消
-2 号码已经不能定位上线  
-3 当前卡池操作繁忙中  
-4 切卡上线锁卡中操作失败
-5 号码切卡上线后指定使用失败,请稍后再试


例如接口地址:http://分配接口IP:9180/service.asmx  查看调用方式,可点击网页的“mkTaskStr”连接查看
Http Get 调用方式:http://分配接口IP:9180/service.asmx/mkTaskStr?token=string&xmid=int&hm=string
 

 





 

二十一、RjGetKsHMStr  获取指定卡商id的号码带软件作者提成接口调用
接口说明:获取指定卡商Id的可做指定项目编码任务的号码带软件作者提成。
参数 类型 说明 备注
token string 登陆token
xmid int 项目编码 要获取号码的项目编码
sl int
获取号码数量,单个号码填1

平台支持一次获取多个号码,如一次需要获取30个可做项目的号码,把获取号码数量参数值设置为 sl=30
 

获取号码数量不能超过帐户可同时获取最大号码数量

 

lx int  

要获取号码类型,0是不限运营商,1是移动号码,2是联通号码,3是电信号码

 

 
a1 string 省份 
参数值为空时表示不限地区,有字符时使用utf-8编码,如“广东”utf-8编码是:%e5%b9%bf%e4%b8%9c

a2 string 城市  

参数值为空时表示不限城市,有字符时使用utf-8编码,如“广东”utf-8编码是:%e5%b9%bf%e4%b8%9c

 

       
ks int 指定卡商id 卡商id可以在业务记录查询里看到
rj int 软件作者帐户id  

用软件作者帐户在Web后台登陆,在页面左上角帐户信息里可看到作者帐户对应的唯一Id

 

 

返回值:string 字符串  请参考 GetHMStr 接口函数返回值说明

例如接口地址:http://分配接口IP:9180/service.asmx  查看调用方式,可点击网页的“RjGetKsHMStr”连接查看
Http Get 调用方式:http://分配接口IP:9180/service.asmx/RjGetKsHMStr?token=string&xmid=int&sl=int&lx=int&a1=string&a2=string&ks=int&rj=int
 

 

二十二、RjGetPKHMStr  获取专属Key的号码带软件作者提成接口调用
接口说明:获取专属Key的号码带软件作者提成。
参数 类型 说明 备注
token string 登陆token
xmid int 项目编码 要获取号码的项目编码
sl int
获取号码数量,单个号码填1

平台支持一次获取多个号码,如一次需要获取30个可做项目的号码,把获取号码数量参数值设置为 sl=30
 

获取号码数量不能超过帐户可同时获取最大号码数量

 

lx int  

要获取号码类型,0是不限运营商,1是移动号码,2是联通号码,3是电信号码

 

 
a1 string 省份 
参数值为空时表示不限地区,有字符时使用utf-8编码,如“广东”utf-8编码是:%e5%b9%bf%e4%b8%9c

a2 string 城市  

参数值为空时表示不限城市,有字符时使用utf-8编码,如“广东”utf-8编码是:%e5%b9%bf%e4%b8%9c

 

       
ks int 指定卡商id 卡商id可以在业务记录查询里看到
rj int 软件作者帐户id  

用软件作者帐户在Web后台登陆,在页面左上角帐户信息里可看到作者帐户对应的唯一Id

 

pk string 专属对接key 如果不是专属对接,该参数值为空
 

返回值:string 字符串  

例如接口地址:http://分配接口IP:9180/service.asmx  查看调用方式,可点击网页的“RjGetPKHMStr”连接查看
Http Get 调用方式:http://分配接口IP:9180/service.asmx/RjGetPKHMStr?token=string&xmid=int&sl=int&lx=int&a1=string&a2=string&ks=int&rj=int&pk=string
 

 

二十三、RjmkPkHMStr  专属指定号码做项目带作者提成接口调用
接口说明:专属指定号码做项目带作者提成,做专属业务时指定号码时作者需要提成请使用该接口。

参数 类型 说明 备注
token string 登陆token
xmid int 项目编码
hm string 指定号码
op int 码库检测方式
0为检测云码库该号码是否已经做过该项目任务,防止做无效的项目任务。

1为不检测码库是否已经做过该项目,强制该号码做该项目任务,一般在解锁或取回密码等类似非注册的项目任务才指定不检测。

pk string 专属key 当是专属项目对应专属key
rj int 软件作者帐户Id


返回值:int 数值 
返回值 说明 备注
1 指定号码成功 成功后可GetYzmStr来取码
0 没登陆
-1 指定号码失败
-2 指定号码当前不在线
-3 指定号码正在被锁定其他用户使用中
-4 项目编码错误
-5 指定号码已经在做该项目任务,不能同时重复同一个项目
如果是语音项目,表示该号码已经有在做语音项目了,同一个号码不能同时做多个不同语音项目,一个号码只能同时做一个语音项目。
-8 余额不足
-9 指定号码卡商已经标识不能做发送项目任务
-10 该号码在云码库中检测到已经做过该项目任务 在码库检测方式op参数为0时才会可能有该返回值出现。
-11 专属对接数据异常
-12 该号码所属卡商已经标识不能做该项目任务了
-13 系统已经禁止该卡商号码做该项目任务
-15 专属项目单价设置异常
-16 指定号码不能指定做该项目 主要是WX项目检测为了防止自己获取注册过WX项目的号码被别人指定号码去登陆顶号盗了,如果指定号码做WX项目,在该号码已经在云码库检测做过,而且做过的帐户不是现指定帐户就会指定失败返回-16
(备注:请禁止使用别人已经注册过号码进行指定号码的验证登陆,否则别人投诉将被封帐号不退款。)
-20 号码不在线,但卡商语音设备在线时,可以尝试切卡上线 返回-20该标识表示可以尝试控制卡商卡池设备跳转切卡到指定号码
-30 指定号码不在线,但号码在卡池设备表中,可以尝试让卡池切卡定位到当前号码
-33 该号码还没成功上报,可能还在切卡处理中或已经切卡失败该号码不能再指定使用

例如接口地址:http://分配接口IP:9180/service.asmx  查看调用方式,可点击网页的“RjmkPkHMStr”连接查看
Http Get 调用方式:http://分配接口IP:9180/service.asmx/RjmkPkHMStr?token=string&xmid=int&hm=string&op=int&pk=string&rj=int

 

 

二十四、sbVoipErrStr  上报错误的语音识别信息接口调用
接口说明:上报错误的语音识别信息,在获取语音验证码后2分钟内上报表错误才生效,超过2分时间拒绝上报。
参数 类型 说明 备注
token string 登陆token
hm string 号码 语音识别错误的号码
xmid int 项目编码 识别错误的项目编码
nr string 收到识别错误的内容,原始包含有语音文件访问地址内容

 

使用utf-8编码,否则平台接收到是乱码上报无效,如“http://”utf-8编码是:http%3a%2f%2f,空格utf-8编码是:%20

 

pk string 专属key 当是专属项目语音对应专属key

返回值:int 数值 
返回值 说明 备注
1 上报成功
0 没登陆
-1 上报失败,查找不到对应数据 接收到验证码内容后,超过2分钟上报识别错误视作无效。
-2 上报失败,查找不到对应上报内容 内容对不上,请检查是否使用utf-8编码正确了。
-3 上报失败,非语音识别项目不能上报 非语音项目不能上报
-4 上报失败,数据异常 生成审核数据时出错
-5 上报失败,已经有号码上报数据,不能重复上报

例如接口地址:http://分配接口IP:9180/service.asmx  查看调用方式,可点击网页的“sbVoipErrStr”连接查看
Http Get 调用方式:http://分配接口IP:9180/service.asmx/sbVoipErrStr?token=string&hm=string&xmid=int&nr=string&pk=string
 

 

二十五、sbYzmErrStr  上报错误接收短信接口调用
接口说明:上报接收短信的错误反馈信息,在获取接收验证码后5分钟内上报表错误才生效,超过5分时间拒绝上报。
参数 类型 说明 备注
token string 登陆token
hm string 号码 分配手机号码
xmid int 项目编码 取号的项目编码
nr string 收到识别错误的内容,需要  

使用utf-8编码,否则平台接收到是乱码上报无效,如“验证码”utf-8编码是:%e9%aa%8c%e8%af%81%e7%a0%81

 

pk string 专属key 当是专属项目语音对应专属key
bz string  

反馈错误详细说明。

(可以直接用固定值负数值 -1:失败,-2:验证码超时,-3:号码已注册)

 

使用utf-8编码,否则平台接收到是乱码上报无效,如“验证码”utf-8编码是:%e9%aa%8c%e8%af%81%e7%a0%81

返回值:int 数值 
返回值 说明 备注
1 上报成功
0 没登陆
-1 上报失败,查找不到对应数据 接收到验证码内容后,超过5分钟上报验证码短信错误视作无效。
-2 上报失败,查找不到对应上报内容 内容对不上,请检查是否使用utf-8编码正确了。
-3 上报失败,平台还没启用上报错误信息反馈功能  
-4 上报失败,数据异常 生成审核数据时出错
-5  

上报失败,号码已经有报错误数据,不能重复上报同一验证码内容错误信息

 

-6 上报失败,反馈错误说明不能为空  

例如接口地址:http://分配接口IP:9180/service.asmx  查看调用方式,可点击网页的“sbYzmErrStr”连接查看
Http Get 调用方式:http://分配接口IP:9180/service.asmx/sbYzmErrStr?token=string&hm=string&xmid=int&nr=string&pk=string&bz=string
 

 

 

 

接口其他补充说明

 

 
一、 关于专属项目对接API处理

    1.专属获取分配号码的调用函数:GetHMStr 参数pk传递卡商专属对接key即可。

    2.专属获取项目接收到验证码短信的调用函数:GetYzmStr 跟非专属一样。  

    3.专属指定号码做项目的调用函数:PKmkHMStr 该接口函数跟非专属mkHMStr接口函数差不多,只是调用时多 一个pk参数传递专属项目对接key值,其他不变,具体请参考mkHMStr 函数调用。 

        例子:http://分配接口IP:9180/service.asmx/PKmkHMStr?token=string&xmid=int&hm=string&op=int&pk=string

 
说明,专属API对接除有用到通用接口函数,专属专用的接口函数名称前面带 PK***** 这样 函数名称标识,除了有以上几点不同外,其他接口功能调用跟正常API调用一样。


 

 





 

 
二、 关于软件作者对接API处理

    1.软件作者对接获取分配号码的调用函数:RjGetHMStr 该接口函数跟 GetHMStr 接口函数差不多,只是调用时 把GetHMStr接口函数的pk参数换成了软件作者帐户id 的参数和值,其他不变,具体请参考GetHMStr 函数调用。

        例子:http://分配接口IP:9180/service.asmx/RjGetHMStr?token=string&xmid=int&sl=int&lx=int&a1=string&a2=string&id=int


    2.软件作者对接获取分配指定卡商Id的号码调用函数:RjGetKsHMStr 该接口函数跟 GetKsHMStr 接口函数差不多,只是调用时 把GetKsHMStr接口函数的卡商id参数换成了ks 的参数和值,增加多一个软件作者的参数rj和值,其他不变,具体请参考GetKsHMStr或GetHMStr 函数调用。

        例子:http://分配接口IP:9180/service.asmx/RjGetKsHMStr?token=string&xmid=int&sl=int&lx=int&a1=string&a2=string&ks=int&rj=int


    3.软件作者对接指定号码做项目的调用函数:RjmkHMStr 该接口函数跟 mkHMStr 接口函数差不多,只是 在后面增加多了一个软件作者帐户id 的参数和值,其他不变,具体请参考mkHMStr 函数调用。  

        例子:http://分配接口IP:9180/service.asmx/RjmkHMStr?token=string&xmid=int&hm=string&op=int&id=int


    4.软件作者对发送短信项目的调用函数:RjSendSmsStr 该接口函数跟SendSmsStr 接口函数差不多,只是调用时 把SendSmsStr接口函数的pk参数换成了软件作者帐户id 的参数和值,其他不变,具体请参考SendSmsStr 函数调用。 

        例子:http://分配接口IP:9180/service.asmx/RjSendSmsStr?token=string&xmid=int&hm=string&nr=string&id=int

 
说明, 软件作者对接API除了以上3个软件作者专用接口函数须用到,其他功能接口函数调用跟平台正常API调用一样,除了不要使用专属对接前面带PK***专用API接口函数,其他功能函数接口都可以使用。





 

备注:平台客户端也是通过该API接口调用处理所有任务功能,客户端 能保存自己每次调用API接口传递数据和返回数据的详细日志,方便参考开发调用API接口实现平台客户端软件的功能,如有些功能不清楚API如何调用,请如下图用平台软件端操作该功能保存调用接口日志查看参考即可,能较多节省API调用开发时间。。。