验证码接收平台API对接的详细说明

admin管理员组

文章数量:1532719

2024年1月9日发(作者：)

极码验证码接收平台API对接的详细说明



系统API的说明

所有注册用户都可以使用接口，无需找管理员开通,所有帐号都可以是开发者！

接口地址： /?action=

接口统一编码：UTF-8

接口调用方式： HTTP，支持GET和POST两种方式。

接口调用时间间隔： 50毫秒。如果低于50毫秒会提示

"message|please try again later"

GET调用方法：/?action=方法名&参数1=值&参数2=值（具体方法名及参数请参考接口方法）

注意：

服务器返回no_data时表示系统暂时没有可用号码了，请使用死循环每隔一分钟请求一次手机号，平台是不定时加号的。

max_count_disable出现这个提示是因为您获取的号码以达到上限，每个获取到的号码都必须正确处理(要么调用ReleaseMobile释放号码退出任务，要么获取验证码，要么号码不能用加黑，要么号码收不到短信加黑。getRecvingInfo方法可以查看您当前获取的手机号码

如果接口返回action_parameter_error 表示传入方法名错误或方法不存在。



用户登录（/ ）

[方法名] loginIn

传入参数：

1. uid:用户名

2. pwd:密码

GET方式调用实例：/?action=loginIn&uid=用户名&pwd=密码

方法调用返回值示例：

1.成功返回：用户名|token(下面所有方法都要用的令牌)

2. 失败返回值说明：

返回值

login_error

说明

用户名密码错误

message|please try again

访问速度过快，建议休眠50毫秒后再试

later

account_is_locked

login_error

账号被锁定

用户名密码错误



获取用户个人信息

[方法名] getUserInfos

传入参数：

1. uid=用户名

2.

token=登录时返回的令牌

GET方式调用实例：/?action=getUserInfos&uid=用户名&token=登录时返回的令牌

方法调用返回值示例：

1.成功返回：用户名;积分;余额;可同时获取号码数

2. 失败返回值说明

返回值

parameter_error

not_login

说明

传入参数错误

没有登录,在没有登录下去访问需要登录的资源，忘记传入uid,token

message|please try again later

访问速度过快，建议休眠50毫秒后再试

account_is_locked

unknow_error

账号被锁定

未知错误,再次请求就会正确返回



获取手机号码

[方法名] getMobilenum

说明：项目ID请登录官网，查看项目管理获得

传入参数：

1. pid=项目ID

2. uid=登录用户名

3. token=登录时返回的令牌

4. lock=是否锁定号码(可以不填写该参数，"1"为锁定。同一个号码接多条短信以上可锁定，以便用已获取的号码来重复接收短信)

5. size=获取号码数(可以不填，默认为1，1<=size<=10)

6. mobile=指定号码获取(可以不填写该参数)

7. cr=指定运营商（1:电信 2:移动 3:联通） (可以不填写该参数)

8. pr=指定省份ID，省份ID看下表（可以不填写）

9. cy=指定城市ID，城市ID看下表（可以不填写）

10. way=地区选择方式，0：选定指定的地区 1：排除指定的地区

省份表：

省份ID 省份名

1

2

3

4

5

6

7

北京市

天津市

河北省

山西省

内蒙古自治区

辽宁省

吉林省

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

黑龙江省

上海市

江苏省

浙江省

安徽省

福建省

江西省

山东省

河南省

湖北省

湖南省

广东省

广西壮族自治区

海南省

重庆市

四川省

贵州省

云南省

西藏自治区

陕西省

甘肃省

青海省

宁夏回族自治区

新疆维吾尔自治区

香港特别行政区

澳门特别行政区

台湾省

指定城市只要填城市ID，所属省份ID不要管，方便查询用的，指定城市是看城市ID就可以了

市区表：

城市ID 所属省份ID 城市名

1

2

3

4

5

6

1

2

3

3

3

3

北京市

天津市

石家庄市

唐山市

秦皇岛市

邯郸市

7 3

8 3

9 3

10 3

11 3

12 3

13 3

14 4

15 4

16 4

17 4

18 4

19 4

20 4

21 4

22 4

23 4

24 4

25 5

26 5

27 5

28 5

29 5

30 5

31 5

32 5

33 5

34 5

35 5

36 5

37 6

38 6

39 6

40 6

41 6

42 6

43 6

邢台市

保定市

张家口市

承德市

沧州市

廊坊市

衡水市

太原市

大同市

阳泉市

长治市

晋城市

朔州市

晋中市

运城市

忻州市

临汾市

吕梁市

呼和浩特市包头市

乌海市

赤峰市

通辽市

鄂尔多斯市呼伦贝尔市巴彦淖尔市乌兰察布市兴安盟

锡林郭勒盟阿拉善盟

沈阳市

大连市

鞍山市

抚顺市

本溪市

丹东市

锦州市

44 6

45 6

46 6

47 6

48 6

49 6

50 6

51 7

52 7

53 7

54 7

55 7

56 7

57 7

58 7

59 7

60 8

61 8

62 8

63 8

64 8

65 8

66 8

67 8

68 8

69 8

70 8

71 8

72 8

73 9

74 10

75 10

76 10

77 10

78 10

79 10

80 10

营口市

阜新市

辽阳市

盘锦市

铁岭市

朝阳市

葫芦岛市

长春市

吉林市

四平市

辽源市

通化市

白山市

松原市

白城市

延边

哈尔滨市

齐齐哈尔市鸡西市

鹤岗市

双鸭山市

大庆市

伊春市

佳木斯市

七台河市

牡丹江市

黑河市

绥化市

大兴安岭

上海市

南京市

无锡市

徐州市

常州市

苏州市

南通市

连云港市

81 10

82 10

83 10

84 10

85 10

86 10

87 11

88 11

89 11

90 11

91 11

92 11

93 11

94 11

95 11

96 11

97 11

98 12

99 12

100 12

101 12

102 12

103 12

104 12

105 12

106 12

107 12

108 12

109 12

110 12

111 12

112 12

113 12

114 12

115 13

116 13

117 13

淮安市

盐城市

扬州市

镇江市

泰州市

宿迁市

杭州市

宁波市

温州市

嘉兴市

湖州市

绍兴市

金华市

衢州市

舟山市

台州市

丽水市

合肥市

芜湖市

蚌埠市

淮南市

马鞍山市淮北市

铜陵市

安庆市

黄山市

滁州市

阜阳市

宿州市

巢湖市

六安市

亳州市

池州市

宣城市

福州市

厦门市

莆田市

118 13

119 13

120 13

121 13

122 13

123 13

124 14

125 14

126 14

127 14

128 14

129 14

130 14

131 14

132 14

133 14

134 14

135 15

136 15

137 15

138 15

139 15

140 15

141 15

142 15

143 15

144 15

145 15

146 15

147 15

148 15

149 15

150 15

151 15

152 16

153 16

154 16

三明市

泉州市

漳州市

南平市

龙岩市

宁德市

南昌市

景德镇市

萍乡市

九江市

新余市

鹰潭市

赣州市

吉安市

宜春市

抚州市

上饶市

济南市

青岛市

淄博市

枣庄市

东营市

烟台市

潍坊市

济宁市

泰安市

威海市

日照市

莱芜市

临沂市

德州市

聊城市

滨州市

荷泽市

郑州市

开封市

洛阳市

155 16

156 16

157 16

158 16

159 16

160 16

161 16

162 16

163 16

164 16

165 16

166 16

167 16

168 16

169 17

170 17

171 17

172 17

173 17

174 17

175 17

176 17

177 17

178 17

179 17

180 17

181 17

182 17

183 18

184 18

185 18

186 18

187 18

188 18

189 18

190 18

191 18

平顶山市

安阳市

鹤壁市

新乡市

焦作市

濮阳市

许昌市

漯河市

三门峡市

南阳市

商丘市

信阳市

周口市

驻马店市

武汉市

黄石市

十堰市

宜昌市

襄樊市

鄂州市

荆门市

孝感市

荆州市

黄冈市

咸宁市

随州市

恩施

神农架

长沙市

株洲市

湘潭市

衡阳市

邵阳市

岳阳市

常德市

张家界市

益阳市

192 18

193 18

194 18

195 18

196 18

197 19

198 19

199 19

200 19

201 19

202 19

203 19

204 19

205 19

206 19

207 19

208 19

209 19

210 19

211 19

212 19

213 19

214 19

215 19

216 19

217 19

218 20

219 20

220 20

221 20

222 20

223 20

224 20

225 20

226 20

227 20

228 20

郴州市

永州市

怀化市

娄底市

湘西

广州市

韶关市

深圳市

珠海市

汕头市

佛山市

江门市

湛江市

茂名市

肇庆市

惠州市

梅州市

汕尾市

河源市

阳江市

清远市

东莞市

中山市

潮州市

揭阳市

云浮市

南宁市

柳州市

桂林市

梧州市

北海市

防城港市钦州市

贵港市

玉林市

百色市

贺州市

229 20

230 20

231 20

232 21

233 21

234 22

235 23

236 23

237 23

238 23

239 23

240 23

241 23

242 23

243 23

244 23

245 23

246 23

247 23

248 23

249 23

250 23

251 23

252 23

253 23

254 23

255 23

256 24

257 24

258 24

259 24

260 24

261 24

262 24

263 24

264 24

265 25

河池市

来宾市

崇左市

海口市

三亚市

重庆市

成都市

自贡市

攀枝花市泸州市

德阳市

绵阳市

广元市

遂宁市

内江市

乐山市

南充市

眉山市

宜宾市

广安市

达州市

雅安市

巴中市

资阳市

阿坝

甘孜

凉山

贵阳市

六盘水市遵义市

安顺市

铜仁

黔西南

毕节

黔东南

黔南布

昆明市

266 25

267 25

268 25

269 25

270 25

271 25

272 25

273 25

274 25

275 25

276 25

277 25

278 25

279 25

280 25

281 26

282 26

283 26

284 26

285 26

286 26

287 26

288 27

289 27

290 27

291 27

292 27

293 27

294 27

295 27

296 27

297 27

298 28

299 28

300 28

301 28

302 28

曲靖市

玉溪市

保山市

昭通市

丽江市

思茅市

临沧市

楚雄

红河

文山

西双版纳大理

德宏

怒江

迪庆

拉萨市

昌都

山南

日喀则

那曲

阿里

林芝

西安市

铜川市

宝鸡市

咸阳市

渭南市

延安市

汉中市

榆林市

安康市

商洛市

兰州市

嘉峪关市金昌市

白银市

天水市

303 28

304 28

305 28

306 28

307 28

308 28

309 28

310 28

311 28

312 29

313 29

314 29

315 29

316 29

317 29

318 29

319 29

320 30

321 30

322 30

323 30

324 30

325 31

326 31

327 31

328 31

329 31

330 31

331 31

332 31

333 31

334 31

335 31

336 31

337 31

338 31

339 31

武威市

张掖市

平凉市

酒泉市

庆阳市

定西市

陇南市

临夏

甘南

西宁市

海东

海北

黄南

海南

果洛

玉树

海西

银川市

石嘴山市

吴忠市

固原市

中卫市

乌鲁木齐市克拉玛依市吐鲁番

哈密

昌吉

博尔塔拉

巴音郭楞

阿克苏

克孜勒苏

喀什

和田

伊犁

塔城

阿勒泰

石河子市

340

341

342

343

344

345

31

31

31

32

33

34

阿拉尔市

图木舒克市

五家渠市

香港

澳门

台湾

GET方式调用实例：/?action=getMobilenum&pid=项目ID&uid=用户名&token=&size=1

方法调用返回值示例：

1.成功返回：手机号码|token 注意：多个号码返回值：手机号;手机号;手机号| token

2. 失败返回值说明：

返回值

no_data

max_count_disable

parameter_error

not_login

说明

系统暂时没有可用号码了

已达到用户可获取号码上限，可通过调用ReleaseMobile方法释放号码并终止任务

传入参数错误

没有登录,在没有登录下去访问需要登录的资源，忘记传入uid,token

message|please try again later

访问速度过快，建议休眠50毫秒后再试

account_is_locked

mobile_notexists

mobile_busy

unknow_error

账号被锁定

指定的号码不存在

指定的号码繁忙

未知错误,再次请求就会正确返回



释放已获取的手机号码

[方法名] ReleaseMobile

说明：此方法可以释放用户获取的所有号码，并终止进行中的任务。该方法使用于将获取到不想使用的号码释放掉（如获取的号码对方网站提示暂时不可用或者注册过多或者没有中奖）则可以调用这个方法。若只释放某个已获取的号码，可加参数“mobile”指定号码释放。

传入参数：

1. uid=用户名

2. token=登录时返回的令牌

3. mobile=已获取到的手机号（仅限单个号码），可不填，不填就释放所有号码

GET方式调用实例：/?action=ReleaseMobile&uid=用户名&token=登录时返回的令牌

方法调用返回值示例：

1.成功返回：OK

2. 失败返回值说明

返回值 说明

parameter_error

传入参数错误

not_login

没有登录,在没有登录下去访问需要登录的资源，忘记传入message|please try again

访问速度过快，建议休眠50毫秒后再试

later

account_is_locked

账号被锁定

unknow_error

未知错误,再次请求就会正确返回



获取验证码并不再使用本号

[方法名]getVcodeAndReleaseMobile

说明：

1.使用该方法获得验证码后，系统自动加黑该号码

2. 因部分短信可能延迟，所以建议该方法每5秒调用一次，调用100秒（可增加获取成功率）

传入参数：

1. mobile=用getMobilenum方法获取到的手机号

2. token=登录时返回的令牌

3. uid=用户名

4. pid=项目ID

5. author_uid=开发者用户名(可选,传入此参数必须是注册类型为软件开发者的用户名，在获取验证码时传入软件开发者用户名,则按本次消费金额的10%奖励给软件开发者)

GET方式调用实例：/?action=getVcodeAndReleaseMobile&uid=用户&token=登录时返回的令牌&pid=项目ID&mobile=获取到的手机号码

方法调用返回值示例：

1.成功返回：手机号码|验证码短信

2. 失败返回值说明：

返回值

not_receive

parameter_error

not_login

message|please try again later

account_is_locked

unknow_error

说明

还没有接收到验证码,请让程序等待几秒后再次尝试

传入参数错误

没有登录,在没有登录下去访问需要登录的资源，忘记传入uid,token

访问速度过快，建议休眠50毫秒后再试

账号被锁定

未知错误,再次请求就会正确返回



获取验证码并继续使用本号

[方法名]getVcodeAndHoldMobilenum

说明：

1.使用该方法获得验证码后，如果这个号码可以多少次使用，下次还会获取

2. 因部分短信可能延迟，所以建议该方法每5秒调用一次，调用100秒（可增加获取成功率）

传入参数：

1. mobile=用getMobilenum方法获取到的手机号

2. token=登录时返回的令牌

3. uid=用户名

4. pid=项目ID

5. author_uid=开发者用户名(可选,传入此参数必须是注册类型为软件开发者的用户名，在获取验证码时传入软件开发者用户名,则按本次消费金额的10%奖励给软件开发者)

GET方式调用实例：/?action=getVcodeAndHoldMobilenum&uid=用户&token=登录时返回的令牌&pid=项目ID&mobile=获取到的手机号码

方法调用返回值示例：

1.成功返回：手机号码|验证码短信

2. 失败返回值说明：

返回值

not_receive

parameter_error

not_login

message|please try again later

account_is_locked

unknow_error

说明

还没有接收到验证码,请让程序等待几秒后再次尝试

传入参数错误

没有登录,在没有登录下去访问需要登录的资源，忘记传入uid,token

访问速度过快，建议休眠50毫秒后再试

账号被锁定

未知错误,再次请求就会正确返回



加黑无用号码

[方法名]addIgnoreList

说明：该方法使用于

1.无法注册的手机号码（对方网站提示不可用）

2. 超过100秒都无法获取短信的手机号码

3. 调用getVcodeAndHoldMobilenum方法使用结束后的号码

传入参数：

1. pid=项目ID

2. mobiles=以,号分隔的手机号列表

3. uid=用户名

=登录时返回的令牌

GET方式调用实例：/?action=addIgnoreList&uid=用户名&token=登录时返回的令牌&mobiles=号码1,号码2,号码3&pid=项目ID

方法调用返回值示例：

1.成功返回：加黑成功的号码数量

2. 失败返回值说明：

返回值

parameter_error

not_login

message|please try again later

account_is_locked

unknow_error

说明

传入参数错误

没有登录,在没有登录下去访问需要登录的资源，忘记传入uid,token

访问速度过快，建议休眠50毫秒后再试

账号被锁定

未知错误,再次请求就会正确返回



已获取号码列表

[方法名]getRecvingInfo

传入参数：

1. uid=用户名

2. token=登录时返回的令牌

3. pid=项目ID（pid等于0的时候获取所有号码，pid不等于0的时候获取指定项目号码）

GET方式调用实例：/?action=getRecvingInfo&uid=用户名&pid=项目ID&token=登录时返回的令牌

方法调用返回值示例：

1. 成功返回：

没有获取号码记录:[ ]

单条：[{"Pid":项目ID,"Recnum":号码,"Timeout":号码超时释放所剩时间,"Start_time":获取号码时间}]（*"Timeout"以秒为单位）

多条：[{"Pid":项目ID,"Recnum":号码,"Timeout":号码超时释放所剩时间,"Start_time":获取号码时间},{"Pid":项目ID,"Recnum":号码,"Timeout":号码超时释放所剩时间,"Start_time":获取号2. 失败返回值说明：

返回值

parameter_error

not_login

message|please try again later

account_is_locked

unknow_error

说明

传入参数错误

没有登录,在没有登录下去访问需要登录的资源，忘记传入uid,token

访问速度过快，建议休眠50毫秒后再试

账号被锁定

未知错误,再次请求就会正确返回



发短信

[方法名]sendSms

说明：调用sendSms方法后，通过 getSmsStatus方法检查短信发送状态

传入参数：

1. pid=项目ID

2. mobile=用getMobilenum方法获取到的手机号

3. uid=用户名

4. token=登录时返回的令牌

5. recv=接收号码，必须是项目指定的接收号码

6. content=短信内容

7. author_uid=开发者用户名(可选,传入此参数必须是注册类型为软件开发者的用户名，在获取验证码时传入软件开发者用户名,则按本次消费金额的10%奖励给软件开发者)

GET方式调用实例：/?action=sendSms&uid=用户名&token=登录时返回的令牌&pid=项目ID&mobile=获取的手机号&recv=短信接收号码&content=短信内容&author_uid=开发者用户名(可选)

方法调用返回值示例：

1.成功返回：OK

2. 失败返回值说明：

返回值

parameter_error

not_login

message|please try again later

account_is_locked

Recv_Err

Task_NotExists

message|此项目不支持发送短信

unknow_error

说明

传入参数错误

没有登录,在没有登录下去访问需要登录的资源，忘记传入uid,token

访问速度过快，建议休眠50毫秒后再试

账号被锁定

短信接收号码不在项目允许的范围内

任务不存在，可能超时被释放，请重新获取号码

此项目不支持发送短信

未知错误,再次请求就会正确返回



获取短信发送状态

[方法名]getSmsStatus

说明：该方法使用于发送短信后，检查短信是否发送成功

传入参数：

1. pid=项目ID

2. mobile=用getMobilenum方法获取到的手机号

3. uid=用户名

4. token=登录时返回的令牌

GET方式调用实例：/?action=getSmsStatus&uid=用户名&token=登录时返回的令牌&pid=项目ID&mobile=获取的手机号

方法调用返回值示例：

1.成功返回：succ

2. 失败返回值说明：

返回值

parameter_error

not_login

message|please try again later

account_is_locked

sending

fail

not_found_project

unknow_error

说明

传入参数错误

没有登录,在没有登录下去访问需要登录的资源，忘记传入uid,token

访问速度过快，建议休眠50毫秒后再试

账号被锁定

发送中

发送失败

没找到发送任务

未知错误,再次请求就会正确返回

本文标签： 号码获取方法登录