| Note |
|---|
Create a task through the createTask method, and then get the result through the getTaskResult method |
| Info |
|---|
This object is used to identify the FuncaptchaIf you obtain an invalid token, please contact us. It will usually work normally after we optimize it. |
Task Type
Task Type | Description | Price | Price(USD) | VIP7 Price(USD) | |||||
|---|---|---|---|---|---|---|---|---|---|
FuncaptchaTaskProxyless | Funcaptcha solution, using server built-in proxy |
| $1.6/1k$1.32/1k |
Create Task
Create a task through the createTask method
...
Parameters | Type | Required | Description |
|---|---|---|---|
clientKey | string | true | Account client key, which can be found in the personal center |
type | string | true | Task type: FuncaptchaTaskProxyless |
websiteURL | string | true | Website url using Funcaptcha, usually a fixed value |
websiteKey | string | true | Funcaptcha site key, a fixed value |
data | string | falseoption | Additional parameter that may be required by FunCaptcha implementation. Use this property to send "blob" value as a stringified array. See example how it may look like. |
funcaptchaApiJSSubdomain | string | falseoption | A special subdomain of |
proxy | string | option | Proxy format: protocol:ip:port:username:password like: "http:111.222.111.222:10103:username:password" * Please note that for FunCAPTCHA solving requests where you are using rotating proxies, you need to ensure that the proxy supports sessions (session id or sticky). Otherwise, we will solve the captcha with an IP that is rotated and does not match the IP you are using, which will result in an invalid captcha. |
cn | bool | option | If your proxy is chinese proxy, set it to true. If not, do not set this parameter if your proxy provider need whitelist, you can add “202.105.112.236” to whitelist (only support chinese proxy on this function) |
**NOTICE
if your proxy provider need whitelist, you can add “202.105.112.236” to whitelist (only support chinese proxy on this function)
Please note that for FunCAPTCHA solving requests where you are using rotating proxies, you need to ensure that the proxy supports sessions (session id or sticky). Otherwise, we will solve the captcha with an IP that is rotated and does not match the IP you are using, which will result in an invalid captcha.
Request Example
| Code Block |
|---|
POST https://api.ez-captcha.com/createTask Content-Type: application/json { "clientKey": "7e5ffc29e3354a19991002f2a19978bb696679", "task": { "websiteURL": "https://signup.live.com/signup2", "websiteKey": "B7D8911C-5CC8-A9A3-35B0-554ACEE604DA", "type": "FuncaptchaTaskProxyless", "proxy": "http:111.222.111.222:10103:username:password" } } |
Request Example (Full Paramaters)
| Code Block |
|---|
POST https://api.ez-captcha.com/createTask
Content-Type: application/json
{
"clientKey": "7e5ffc29e3354a19991002f2a19978bb696679",
"task": {
"websiteURL": "https://signup.live.com/signup2",
"websiteKey": "B7D8911C-5CC8-A9A3-35B0-554ACEE604DA",
"type": "FuncaptchaTaskProxyless",
"proxy": "http:111.222.111.222:10103:username:password",
"data": "{\"blob\": \"zovhMwTRjCpfcVNl.I9rn5oNdZetyte0643eFqqSN3K8u+kdF/0VP9UCqRtUxAjg8ULXcPw8xyOSVWdm0LPfbSXgjWNgGjZjeE1wuiJvhG9BPGIZkXMQQhA8mYf9E8X6WdvyscLq53RNPO2575GJ86nUOOQOAgjTmLI9NPpPfBaBwRVqaYxFVtp03H+fEDgsqvc6Jy2pviPMHi/5v2jE46AoM0GG+4qjGD+jUZaibttCxTiYnWzYmnHG1bp2SiFVDArttDciqcBC2st9eeNioC0D7Ym0ONt2dCJk6LIQaLlqg1ieTEw9t4Y6lQsfUzH/bMNjOPapqYVmH0IuVSt/v8uPu5zqIZ/8OweXEU92b2BBzEXw6IK11Y0cwLZWldPIx1B1NqajlG3LfMEoe8Y3dayXKkASymacvX6tXKKkeZDUs8Zz7SZ4OldU5hdNn7RVsomMseG2l2pGzmVTXSFL8s2EavAl7GTTKDdzSX1qeBDHVbfQ3/9vkKwGdQ5J3+tQjtw1fP00c1AL5/fMIL+Io9odEyaOgqnK0pdg7UN+67LUcIo8T86F76nn9Pqjle5hywsZjmaKJALg2Sd7pA+l1e64/HrW7AdT+ZTfM7Q2Oc/Et/6hY6eOZiG21Ny3CSg==\"}"
}
} |
Response Example
| Code Block |
|---|
{
"errorId": 0,
"errorCode": "",
"errorDescription": "",
"taskId": "61138bb6-19fb-11ec-a9c8-0242ac110006" // 请记录此ID Please record this ID
} |
Get Result
Use the getTaskResult method to get the recognition result
...
| Code Block |
|---|
POST https://api.ez-captcha.com/getTaskResult
Content-Type: application/json
{
"clientKey":"YOUR_API_KEY",
"taskId": "TASKID OF CREATETASK" //TaskID created by createTask api
} |
...
Response Data
Parameter | Type | Description |
|---|---|---|
errorId | Integer | Error message: 0 - no error, 1 - error |
errorCode | string | Error code, click here to view all error list |
errorDescription | string | Detailed error description |
status | string | processing - task is in progress, please try again in 1 seconds ready - task is complete, find the result in the solution parameter |
solution | Object | The recognition result will be different for different types of captcha. For Funcaptcha, the result is token in the object. |
solution.token | string | Recognition result: token value, used for POST or simulate d submission to the target website. It is recommended to use immediately |
...