aljaz/signal-cli-rest-api
1
0
Fork 0
mirror of https://github.com/aljazceru/signal-cli-rest-api.git synced 2025-12-19 23:54:22 +01:00
Code Issues Packages Projects Releases Wiki Activity

added /v1/rate-limit-challenge endpoint

Browse Source 
see #456
This commit is contained in:
Bernhard B
2023-12-01 21:01:58 +01:00
parent 6f2fadf5ac
commit 13236b7c66
6 changed files with 208 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
src/docs/docs.go
View File

@@ -47,7 +47,7 @@ var doc = `{
},
"/v1/accounts": {
"get": {
"description": "Lists all of the devices linked or registered",
"description": "Lists all of the accounts linked or registered",
"produces": [
"application/json"
],
@@ -74,6 +74,48 @@ var doc = `{
}
}
},
"/v1/accounts/{number}/rate-limit-challenge": {
"post": {
"description": "When running into rate limits, sometimes the limit can be lifted, by solving a CAPTCHA. To get the captcha token, go to https://signalcaptchas.org/challenge/generate.html For the staging environment, use: https://signalcaptchas.org/staging/registration/generate.html. The \"challenge_token\" is the token from the failed send attempt. The \"captcha\" is the captcha result, starting with signalcaptcha://",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Accounts"
],
"summary": "Lift rate limit restrictions by solving a captcha.",
"parameters": [
{
"type": "string",
"description": "Registered Phone Number",
"name": "number",
"in": "path",
"required": true
},
{
"description": "Request",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/api.RateLimitChallengeRequest"
}
}
],
"responses": {
"204": {},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/api.Error"
}
}
}
}
},
"/v1/attachments": {
"get": {
"description": "List all downloaded attachments",
@@ -1779,6 +1821,19 @@ var doc = `{
}
}
},
"api.RateLimitChallengeRequest": {
"type": "object",
"properties": {
"captcha": {
"type": "string",
"example": "signalcaptcha://{captcha value}"
},
"challenge_token": {
"type": "string",
"example": "\u003cchallenge token\u003e"
}
}
},
"api.Reaction": {
"type": "object",
"properties": {