標籤:驗證 傳參 號碼 返回 question 無法 str 逾時 使用
速碼平台API介面樣本【通用版】
一、統一說明
- 介面地址:http://api.eobzz.com/httpApi.do?action=
- 介面統一編碼:UTF-8
- 介面調用方式: HTTP,支援GET和POST兩種方式。
- GET方式調用執行個體:http://api.eobzz.com/httpApi.do?action=方法名&參數1=值&參數2=值(具體方法名及參數請參考介面方法)。
軟體開發人員說明:伺服器返回no_data時表示系統暫時沒有可用號碼了,請使用死迴圈每隔一分鐘請求一次手機號,速碼平台是不定時加號的。 max_count_disable出現這個提示是因為您擷取的號碼沒有正常處理,每個擷取到的號碼都必須正確處理(要麼擷取驗證碼,要麼號碼不能用加黑,要麼號碼收不到簡訊加黑。getRecvingInfo方法可以查看您當前擷取的手機號碼 如果介面返回action_parameter_error 表示傳入方法名錯誤或方法不存在。
二、介面方法
1、
使用者登入
1)方法名:loginIn
2)傳入參數:
3)GET方式調用執行個體:
- http://api.eobzz.com/httpApi.do?action=loginIn&uid=使用者名稱&pwd=密碼
4)方法調用傳回值樣本:
1))成功返回:使用者名稱|token(下面所有方法都要用的令牌)
2))失敗傳回值&說明:
- login_error使用者名稱密碼錯誤
- message|速度過快,請稍後再試訪問速度過快,建議休眠50毫秒後再試
- account_is_locked帳號被鎖定
- account_is_stoped帳號被停用
- account_is_question_locked帳號已關閉
- account_is_ip_stoped帳號ip鎖定
- account_is_FreezeUser帳號被凍結
2、擷取使用者個人資訊
1)方法名:getUserInfos
2)傳入參數:
3)GET方式調用執行個體:
- http://api.eobzz.com/httpApi.do?action=getUserInfos&uid=使用者名稱&token=登入時返回的令牌
4)方法調用傳回值樣本:
1))成功返回:使用者名稱;積分;餘額;可同時擷取號碼數
2))失敗傳回值&說明:
- parameter_error傳入參數錯誤
- not_login沒有登入,在沒有登入下去訪問需要登入的資源,忘記傳入uid,token
- account_is_locked帳號被鎖定
- account_is_stoped帳號被停用
- account_is_question_locked帳號已關閉
- account_is_ip_stoped帳號ip鎖定
- message|please try again later訪問速度過快,建議休眠50毫秒後再試
- unknow_error未知錯誤,再次請求就會正確返回
3、擷取手機號碼
1)方法名:getMobilenum
2)傳入參數:
- pid=項目ID
- uid=登入使用者名稱
- token=登入時返回的令牌
- mobile=指定號碼擷取(可以不填寫該參數,如填入格式不正確則擷取新號碼)
- size=擷取號碼數(可以不填,預設為1,1<=size<=10)
- province=歸屬地(省份,例如:廣東、北京)
- province值:廣東|遼寧|湖南|內蒙古|浙江|安徽|貴州|西藏|黑龍江|陝西|廣西|湖北|福建|山西|江西|海南|江蘇|雲南|河南|山東|新疆|青海|吉林|河北|寧夏|北京|天津|上海|四川|重慶|甘肅
- province中文傳參時可能產生亂碼,最好經過URL轉碼,(例如:java轉碼方式 java.net.URLEncoder.encode("廣東","UTF-8"))。
- phoneType=電訊廠商(CMCC(移動)、UNICOM(聯通)、TELECOM(電信)) 。
3)GET方式調用執行個體:
- http://api.eobzz.com/httpApi.do?action=getMobilenum&pid=項目ID&uid=使用者名稱&token=&mobile=&size=1
4)歸屬地、電訊廠商調用執行個體:
- http://api.eobzz.com/httpApi.do?action=getMobilenum&pid=項目ID&uid=使用者名稱&token=&mobile=&size=1&province=廣東&phoneType=CMCC
5)方法調用傳回值樣本:
1))成功返回:手機號碼|token
注意:多個號碼傳回值:手機號;手機號;手機號| token
2))失敗傳回值&說明:
- no_data系統暫時沒有可用號碼了
- parameter_error傳入參數錯誤
- not_login沒有登入,在沒有登入下去訪問需要登入的資源,忘記傳入uid,token
- account_is_locked帳號被鎖定
- account_is_stoped帳號被停用
- account_is_question_locked帳號已關閉
- account_is_ip_stoped帳號ip鎖定
- message|速度過快,請稍後再試訪問速度過快,建議休眠50毫秒後再試
- not_found_project沒有找到項目,項目ID不正
- message|可使用餘額不足可使用餘額不足
- max_count_disable已經達到了當前等級可以擷取手機號的最大數量,請先處理完您手上的號碼再擷取新的號碼(處理方式:能用的號碼就擷取驗證碼,不能用的號碼就加黑)
- unknow_error未知錯誤,再次請求就會正確返回
4、擷取驗證碼並不再使用本號
1)方法名:getVcodeAndReleaseMobile
2)傳入參數:
- mobile=用getMobilenum方法擷取到的手機號
- token=登入時返回的令牌
- uid=使用者名稱
- author_uid=軟體開發人員使用者名稱(可選, 可得10%的消費分成)
3)GET方式調用執行個體:
- http://api.eobzz.com/httpApi.do?action=getVcodeAndReleaseMobile&uid=使用者&token=登入時返回的令牌&mobile=擷取到的手機號碼&author_uid=軟體開發人員使用者名稱(可選, 可得10%的消費分成)
4)方法調用傳回值樣本:
1))成功返回:手機號碼|驗證碼簡訊
2))失敗傳回值&說明:
- ? not_receive還沒有接收到驗證碼,請讓程式等待幾秒後再次嘗試
- ? parameter_error傳入參數錯誤
- ? not_login沒有登入,在沒有登入下去訪問需要登入的資源,忘記傳入uid,token
- ? account_is_locked帳號被鎖定
- ? account_is_stoped帳號被停用
- ? account_is_question_locked帳號已關閉
- ? account_is_ip_stoped帳號ip鎖定
- ? message|please try again later訪問速度過快,建議休眠50毫秒後再試
- ? message|可使用餘額不足可使用餘額不足
- ? not_found_moblie沒有找到手機號
- not_found_project沒有找到項目,項目ID不正確
5、擷取驗證碼並繼續使用本號
1)方法名:getVcodeAndHoldMobilenum
2)傳入參數:
- mobile=用getMobilenum方法擷取到的手機號
- uid=使用者名稱
- token=登入時返回的令牌
- next_pid=下個要接收的項目ID
- author_uid=軟體開發人員使用者名稱(可選, 可得10%的消費分成)
3)GET方式調用執行個體:
- http://api.eobzz.com/httpApi.do?action=getVcodeAndHoldMobilenum&uid=使用者&token=登入時返回的令牌&mobile=擷取到的手機號碼&next_pid=下個要接收的項目ID&author_uid=軟體開發人員使用者名稱(可選, 可得10%的消費分成)
4)方法調用傳回值樣本:
1))成功返回:發送號碼|驗證碼| token
2))失敗傳回值&說明:
- ? not_receive還沒有接收到驗證碼,請讓程式等待幾秒後再次嘗試
- parameter_error傳入參數錯誤
- not_login沒有登入,在沒有登入下去訪問需要登入的資源,忘記傳入uid,token
- account_is_locked帳號被鎖定
- account_is_stoped帳號被停用
- account_is_question_locked帳號已關閉
- ? account_is_ip_stoped帳號ip鎖定
- message|please try again later訪問速度過快,建議休眠50毫秒後再試
- message|可使用餘額不足可使用餘額不足
- not_found_moblie沒有找到手機號
- not_found_project沒有找到項目,項目ID不正確
- unknow_error未知錯誤,再次請求就會正確返回
6、加黑無用號碼
1)方法名:addIgnoreList
2)傳入參數:
- pid=項目ID
- mobiles=以,號分隔的手機號列表
- uid=使用者名稱
- token=登入時返回的令牌
3)GET方式調用執行個體:
- ? http://api.eobzz.com/httpApi.do?action=addIgnoreList&uid=使用者名稱&token=登入時返回的令牌&mobiles=號碼1,號碼2,號碼3&pid=項目ID
4)方法調用傳回值樣本:
1))成功返回:加黑成功的號碼數量
2))失敗傳回值&說明:
- ? parameter_error傳入參數錯誤
- ? not_login沒有登入,在沒有登入下去訪問需要登入的資源,忘記傳入uid,token
- ? account_is_locked帳號被鎖定
- ? account_is_stoped帳號被停用
- ? account_is_question_locked帳號已關閉
- ? account_is_ip_stoped帳號ip鎖定
- ? unknow_error未知錯誤,再次請求就會正確返回
7、已擷取號碼列表
1)方法名:getRecvingInfo
2)傳入參數:
- uid=使用者名稱
- token=登入時返回的令牌
- pid=項目ID(pid等於0的時候擷取所有號碼,pid不等於0的時候擷取指定項目號碼)
3)GET方式調用執行個體:
- http://api.eobzz.com/httpApi.do?action=getRecvingInfo&uid=使用者名稱&pid=項目ID&token=登入時返回的令牌
4)方法調用傳回值樣本:
1))成功返回: 沒有擷取號碼記錄:[ ] 單條:[{"Pid":項目ID,"Recnum":號碼,"Timeout":號碼逾時釋放所剩時間,"Start_time":擷取號碼時間}](*"Timeout"以秒為單位) 多條:[{"Pid":項目ID,"Recnum":號碼,"Timeout":號碼逾時釋放所剩時間,"Start_time":擷取號碼時間},{"Pid":項目ID,"Recnum":號碼,"Timeout":號碼逾時釋放所剩時間,"Start_time":擷取號碼時間},{...}](*"Timeout"以秒為單位)
2))失敗傳回值說明:
- ? parameter_error傳入參數錯誤
- ? not_login沒有登入,在沒有登入下去訪問需要登入的資源,忘記傳入uid,token
- ? account_is_locked帳號被鎖定
- ? account_is_stoped帳號被停用
- ? account_is_question_locked帳號已關閉
- ? account_is_ip_stoped帳號ip鎖定
- ? message|please try again later訪問速度過快,建議休眠100毫秒後再試
- ? not_found_moblie沒有找到手機號
- ? not_found_project沒有找到項目,項目ID不正確
- ? message|可使用餘額不足可使用餘額不足
- ? not_send號碼已下線,無法發送
- ? fail失敗
- unknow_error未知錯誤,再次請求就會正確返回
速碼驗證碼接碼平台API接入樣本說明