Optional params (#24)

kratzky · web-flow · commit 4a7182db3fb9 · 2023-08-30T08:11:04.000-03:00
* added additional parameters

* updated tests

* updated readme
diff --git a/README.md b/README.md
@@ -1,33 +1,37 @@
 # C# Module for 2Captcha API
 The easiest way to quickly integrate [2Captcha] into your code to automate solving of any types of captcha.
 
-- [Installation](#installation)
-- [Configuration](#configuration)
-- [Solve captcha](#solve-captcha)
-  - [Normal Captcha](#normal-captcha)
-  - [Text](#text-captcha)
-  - [ReCaptcha v2](#recaptcha-v2)
-  - [ReCaptcha v3](#recaptcha-v3)
-  - [FunCaptcha](#funcaptcha)
-  - [GeeTest](#geetest)
-  - [GeeTestV4](#geetestv4)
-  - [hCaptcha](#hcaptcha)
-  - [KeyCaptcha](#keycaptcha)
-  - [Capy](#capy)
-  - [Grid (ReCaptcha V2 Old Method)](#grid)
-  - [Canvas](#canvas)
-  - [ClickCaptcha](#clickcaptcha)
-  - [Rotate](#rotate)
-  - [Audio](#audio)
-  - [Yandex](#yandex)
-  - [Lemin](#lemin)
-  - [Turnstile](#turnstile)
-  - [AmazonWaf](#amazonwaf)
-- [Other methods](#other-methods)
-  - [send / getResult](#send--getresult)
-  - [balance](#balance)
-  - [report](#report)
-- [Error handling](#error-handling)
+- [C# Module for 2Captcha API](#c-module-for-2captcha-api)
+  - [Installation](#installation)
+  - [Configuration](#configuration)
+    - [TwoCaptcha instance options](#twocaptcha-instance-options)
+  - [Solve captcha](#solve-captcha)
+    - [Captcha options](#captcha-options)
+    - [Basic example](#basic-example)
+    - [Normal Captcha](#normal-captcha)
+    - [Text Captcha](#text-captcha)
+    - [ReCaptcha v2](#recaptcha-v2)
+    - [ReCaptcha v3](#recaptcha-v3)
+    - [FunCaptcha](#funcaptcha)
+    - [GeeTest](#geetest)
+    - [GeeTestV4](#geetestv4)
+    - [hCaptcha](#hcaptcha)
+    - [KeyCaptcha](#keycaptcha)
+    - [Capy](#capy)
+    - [Grid](#grid)
+    - [Canvas](#canvas)
+    - [ClickCaptcha](#clickcaptcha)
+    - [Rotate](#rotate)
+    - [Audio](#audio)
+    - [Yandex](#yandex)
+    - [Lemin](#lemin)
+    - [Turnstile](#turnstile)
+    - [AmazonWaf](#amazonwaf)
+  - [Other methods](#other-methods)
+    - [send / getResult](#send--getresult)
+    - [balance](#balance)
+    - [report](#report)
+  - [Error handling](#error-handling)
 
 ## Installation
 Install nuget package from [nuget]
@@ -48,13 +52,13 @@ solver.PollingInterval = 10;
 
 ### TwoCaptcha instance options
 
-|Option|Default value|Description|
-|---|---|---|
-|softId|-|your software ID obtained after publishing in [2captcha sofware catalog]|
-|callback|-|URL of your web-sever that receives the captcha recognition result. The URl should be first registered in [pingback settings] of your account|
-|defaultTimeout|120|Polling timeout in seconds for all captcha types except ReCaptcha. Defines how long the module tries to get the answer from `res.php` API endpoint|
-|recaptchaTimeout|600|Polling timeout for ReCaptcha in seconds. Defines how long the module tries to get the answer from `res.php` API endpoint|
-|pollingInterval|10|Interval in seconds between requests to `res.php` API endpoint, setting values less than 5 seconds is not recommended|
+| Option           | Default value | Description                                                                                                                                        |
+| ---------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
+| softId           | -             | your software ID obtained after publishing in [2captcha sofware catalog]                                                                           |
+| callback         | -             | URL of your web-sever that receives the captcha recognition result. The URl should be first registered in [pingback settings] of your account      |
+| defaultTimeout   | 120           | Polling timeout in seconds for all captcha types except ReCaptcha. Defines how long the module tries to get the answer from `res.php` API endpoint |
+| recaptchaTimeout | 600           | Polling timeout for ReCaptcha in seconds. Defines how long the module tries to get the answer from `res.php` API endpoint                          |
+| pollingInterval  | 10            | Interval in seconds between requests to `res.php` API endpoint, setting values less than 5 seconds is not recommended                              |
 
 >  **IMPORTANT:** once `Callback` is defined for `TwoCaptcha` instance, all methods return only the captcha ID and DO NOT poll the API to get the result. The result will be sent to the callback URL.
 To get the answer manually use [getResult method](#send--getresult)
@@ -63,17 +67,17 @@ To get the answer manually use [getResult method](#send--getresult)
 When you submit any image-based captcha use can provide additional options to help 2captcha workers to solve it properly.
 
 ### Captcha options
-|Option|Default Value|Description|
-|---|---|---|
-|numeric|0|Defines if captcha contains numeric or other symbols [see more info in the API docs][post options]|
-|minLength|0|minimal answer lenght|
-|maxLength|0|maximum answer length|
-|phrase|0|defines if the answer contains multiple words or not|
-|caseSensitive|0|defines if the answer is case sensitive|
-|calc|0|defines captcha requires calculation|
-|lang|-|defines the captcha language, see the [list of supported languages] |
-|hintImg|-|an image with hint shown to workers with the captcha|
-|hintText|-|hint or task text shown to workers with the captcha|
+| Option        | Default Value | Description                                                                                        |
+| ------------- | ------------- | -------------------------------------------------------------------------------------------------- |
+| numeric       | 0             | Defines if captcha contains numeric or other symbols [see more info in the API docs][post options] |
+| minLength     | 0             | minimal answer lenght                                                                              |
+| maxLength     | 0             | maximum answer length                                                                              |
+| phrase        | 0             | defines if the answer contains multiple words or not                                               |
+| caseSensitive | 0             | defines if the answer is case sensitive                                                            |
+| calc          | 0             | defines captcha requires calculation                                                               |
+| lang          | -             | defines the captcha language, see the [list of supported languages]                                |
+| hintImg       | -             | an image with hint shown to workers with the captcha                                               |
+| hintText      | -             | hint or task text shown to workers with the captcha                                                |
 
 Below you can find basic examples for every captcha type. Check out [examples directory] to find more examples with all available options.
 
@@ -194,6 +198,7 @@ Use this method to solve hCaptcha challenge. Returns a token to bypass captcha.
 HCaptcha captcha = new HCaptcha();
 captcha.SetSiteKey("10000000-ffff-ffff-ffff-000000000001");
 captcha.SetUrl("https://www.site.com/page/");
+captcha.SetData("foo");
 captcha.SetProxy("HTTPS", "login:password@IP_address:PORT");
 ```
 
@@ -307,6 +312,9 @@ Use this method to solve Turnstile and obtain a token to bypass the protection.
 Turnstile captcha = new Turnstile();
 captcha.SetSiteKey("0x4AAAAAAAChNiVJM_WtShFf");
 captcha.SetUrl("https://ace.fusionist.io");
+captcha.SetData("foo");
+captcha.SetPageData("bar");
+captcha.SetAction("baz");
 ```
 
 ### AmazonWaf
diff --git a/TwoCaptcha.Tests/HCaptchaTest.cs b/TwoCaptcha.Tests/HCaptchaTest.cs
@@ -14,11 +14,13 @@ public async Task TestAllOptions()
             HCaptcha captcha = new HCaptcha();
             captcha.SetSiteKey("f1ab2cdefa3456789012345b6c78d90e");
             captcha.SetUrl("https://www.site.com/page/");
+            captcha.SetData("foo");
 
             var parameters = new Dictionary<string, string>();
             parameters["method"] = "hcaptcha";
             parameters["sitekey"] = "f1ab2cdefa3456789012345b6c78d90e";
             parameters["pageurl"] = "https://www.site.com/page/";
+            parameters["data"] = "foo";
 
             await CheckIfCorrectParamsSendAndResultReturned(captcha, parameters);
         }
diff --git a/TwoCaptcha.Tests/ReCaptchaTest.cs b/TwoCaptcha.Tests/ReCaptchaTest.cs
@@ -18,6 +18,7 @@ public async Task TestV2()
             captcha.SetInvisible(true);
             captcha.SetAction("verify");
             captcha.SetDomain("recaptcha.net");
+            captcha.SetDataS("foo");
 
             var parameters = new Dictionary<string, string>();
             parameters["method"] = "userrecaptcha";
@@ -26,6 +27,7 @@ public async Task TestV2()
             parameters["invisible"] = "1";
             parameters["action"] = "verify";
             parameters["domain"] = "recaptcha.net";
+            parameters["data-s"] = "foo";
 
             await CheckIfCorrectParamsSendAndResultReturned(captcha, parameters);
         }
diff --git a/TwoCaptcha.Tests/TurnstileTest.cs b/TwoCaptcha.Tests/TurnstileTest.cs
@@ -14,11 +14,17 @@ public async Task TestAllOptions()
             Turnstile captcha = new Turnstile();
             captcha.SetSiteKey("0x4AAAAAAAChNiVJM_WtShFf");
             captcha.SetUrl("https://ace.fusionist.io");
+            captcha.SetData("foo");
+            captcha.SetPageData("bar");
+            captcha.SetAction("baz");
 
             var parameters = new Dictionary<string, string>();
             parameters["method"] = "turnstile";
             parameters["sitekey"] = "0x4AAAAAAAChNiVJM_WtShFf";
             parameters["pageurl"] = "https://ace.fusionist.io";
+            parameters["data"] = "foo";
+            parameters["pagedata"] = "bar";
+            parameters["action"] = "baz";
 
             await CheckIfCorrectParamsSendAndResultReturned(captcha, parameters);
         }
diff --git a/TwoCaptcha/Captcha/HCaptcha.cs b/TwoCaptcha/Captcha/HCaptcha.cs
@@ -16,5 +16,10 @@ public void SetUrl(string url)
         {
             parameters["pageurl"] = url;
         }
+
+        public void SetData(string data)
+        {
+            parameters["data"] = data;
+        }
     }
 }
diff --git a/TwoCaptcha/Captcha/ReCaptcha.cs b/TwoCaptcha/Captcha/ReCaptcha.cs
@@ -48,5 +48,10 @@ public void SetEnterprise(bool invisible)
         {
             parameters["enterprise"] = invisible ? "1" : "0";
         }
+
+        public void SetDataS(string data)
+        {
+            parameters["data-s"] = data;
+        }
     }
 }
diff --git a/TwoCaptcha/Captcha/Turnstile.cs b/TwoCaptcha/Captcha/Turnstile.cs
@@ -16,5 +16,18 @@ public void SetUrl(string url)
         {
             parameters["pageurl"] = url;
         }
+
+        public void SetAction(string action)
+        {
+            parameters["action"] = action;
+        }
+        public void SetData(string data)
+        {
+            parameters["data"] = data;
+        }
+        public void SetPageData(string pagedata)
+        {
+            parameters["pagedata"] = pagedata;
+        }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -16,5 +16,10 @@ public void SetUrl(string url)`
`16`	`16`	`{`
`17`	`17`	`parameters["pageurl"] = url;`
`18`	`18`	`}`
	`19`	`+`
	`20`	`+ public void SetData(string data)`
	`21`	`+ {`
	`22`	`+ parameters["data"] = data;`
	`23`	`+ }`
`19`	`24`	`}`
`20`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -48,5 +48,10 @@ public void SetEnterprise(bool invisible)`
`48`	`48`	`{`
`49`	`49`	`parameters["enterprise"] = invisible ? "1" : "0";`
`50`	`50`	`}`
	`51`	`+`
	`52`	`+ public void SetDataS(string data)`
	`53`	`+ {`
	`54`	`+ parameters["data-s"] = data;`
	`55`	`+ }`
`51`	`56`	`}`
`52`	`57`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,5 +16,18 @@ public void SetUrl(string url)`
`16`	`16`	`{`
`17`	`17`	`parameters["pageurl"] = url;`
`18`	`18`	`}`
	`19`	`+`
	`20`	`+ public void SetAction(string action)`
	`21`	`+ {`
	`22`	`+ parameters["action"] = action;`
	`23`	`+ }`
	`24`	`+ public void SetData(string data)`
	`25`	`+ {`
	`26`	`+ parameters["data"] = data;`
	`27`	`+ }`
	`28`	`+ public void SetPageData(string pagedata)`
	`29`	`+ {`
	`30`	`+ parameters["pagedata"] = pagedata;`
	`31`	`+ }`
`19`	`32`	`}`
`20`	`33`	`}`