Documentation

Store Blacklist Numbers API

This API allows you to add a blacklisted number to the system.


1. Endpoint

Method: POST


URL: https://texttorrent.com/api/v1/store-blacklisted-number


Content-Type: multipart/form-data


Authentication: API Key required

2. Authentication

Include your API key in the request headers:

api-key: YOUR_API_KEY

If the API key is invalid or missing, you will receive:

{
    "status": false,
    "message": "Invalid API key"
}

Response Code: 401 Unauthorized

3. Request Parameters
Parameter Type Required Description
first_name String Yes First name of the user
last_name String Yes Last name of the user
email String Yes Email address of the user
number String Yes Phone number (Format: +16268549595)
company String No Company name (optional)
4. Sample Request
curl --request POST 'https://texttorrent.com/api/v1/store-blacklisted-number' \
--header 'api-key: YOUR_API_KEY' \
--header 'Content-Type: multipart/form-data' \
--form 'first_name=Jhonson' \
--form 'last_name=Charlse' \
--form 'email=jhon@example.com' \
--form 'number=+16268549595' \
--form 'company=ABCD'
5. Success Response
{
    "status": true,
    "message": "Number received"
}

Response Code: 200 OK

6. Error Responses
Missing Required Fields:
{
    "status_code": 403,
    "message": {
        "first_name": ["The first name field is required."],
        "number": ["The number field is required."]
    }
}

Response Code: 403 Forbidden


Invalid API Key:
{
    "status": false,
    "message": "Invalid API key"
}

Response Code: 401 Unauthorized


Server Error:
{
    "status": false,
    "message": "Something went wrong. Please try again later."
}

Response Code: 500 Internal Server Error

7. Notes
  • The number field must follow the format +XXXXXXXXXXX.
  • Ensure the API key is valid before making a request.
  • Only authorized users can access this endpoint.
8. Contact Support

If you experience issues, please contact support@texttorrent.com.