{"id":19540801,"url":"https://github.com/skocimis/textlink-py","last_synced_at":"2025-06-18T07:35:50.546Z","repository":{"id":226510116,"uuid":"768868529","full_name":"Skocimis/textlink-py","owner":"Skocimis","description":"Python library that helps you send SMS and verify users using the TextLink API","archived":false,"fork":false,"pushed_at":"2024-03-07T23:45:12.000Z","size":4,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-08T18:36:39.451Z","etag":null,"topics":["api","api-client","bulk-sms","python","python3","simple-sms","sms","sms-api","sms-gateway","sms-verification","text-message","user-verification"],"latest_commit_sha":null,"homepage":"https://textlinksms.com","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Skocimis.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2024-03-07T22:09:30.000Z","updated_at":"2024-09-23T23:19:42.000Z","dependencies_parsed_at":"2024-03-08T00:44:28.007Z","dependency_job_id":null,"html_url":"https://github.com/Skocimis/textlink-py","commit_stats":null,"previous_names":["skocimis/textlink-py"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Skocimis%2Ftextlink-py","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Skocimis%2Ftextlink-py/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Skocimis%2Ftextlink-py/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Skocimis%2Ftextlink-py/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Skocimis","download_url":"https://codeload.github.com/Skocimis/textlink-py/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240795007,"owners_count":19858725,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","api-client","bulk-sms","python","python3","simple-sms","sms","sms-api","sms-gateway","sms-verification","text-message","user-verification"],"created_at":"2024-11-11T03:07:08.313Z","updated_at":"2025-02-26T05:17:04.685Z","avatar_url":"https://github.com/Skocimis.png","language":"Python","readme":"# TextLink python client\n\n[![PyPI](https://img.shields.io/pypi/v/textlink.svg)](https://pypi.python.org/pypi/textlink)\n[![PyPI](https://img.shields.io/pypi/pyversions/textlink.svg)](https://pypi.python.org/pypi/textlink)\n\n### Supported Python Versions\n\nThis library supports the following Python implementations:\n\n* Python 3.6\n* Python 3.7\n* Python 3.8\n* Python 3.9\n* Python 3.10\n* Python 3.11\n* Python 3.12\n\n## Installation\n`pip install textlink`\n\n## Sending an SMS\n\nTo send an SMS, you have to create an API key using the [TextLink dashboard](https://textlinksms.com/dashboard/api). When you register an account, you automatically get an API key with one free SMS which you can send anywhere.\n\n### Just send a message\n\n```python\nimport textlinksms as tl\ntl.useKey(\"YOUR_API_KEY\")\n\ntl.sendSMS(\"+381611231234\", \"Dummy message text...\")\n```\n\n### Handle response\n\n```python\nresult = tl.sendSMS(\"+381611231234\", \"Dummy message text...\")\nif(result.ok):\n  print(result.data)\nelse:\n  print(result.message)\n```\n\n### Example result object of the successfully sent message\n\n```json\n{\n    \"ok\": true\n}\n```\n\n### Example result object of the unsuccessfully sent message\n\n```json\n{\n    \"ok\": false,\n    \"message\": \"API key not found\"\n}\n```\n\n## Verifying a phone number\n\nYou can also use our service to easily verify a phone number, without storing data about the phones that you are about to verify, because we can do it for you.\n\n### Example usage\n\n```python\n# User has sent his phone number for verification\nresultSMS = tl.sendVerificationSMS (\"+11234567890\", service_name, expiration_time, source_country)\n\n# Show him the code submission form\n# We will handle the verification code ourselves\n\n# The user has submitted the code\nresultCode = tl.verifyCode(\"+11234567890\", user_entered_code)\n# if `resultCode.valid` is True, then the phone number is verified. \n```\n\n#### Verification options (Optional)\n\n`service_name` is what the user will see in the verification message, e. g. `\"Your verification code for Guest is: CODE\"`\n\n`expiration_time` is how many miliseconds the code is valid. Default is 10 minutes.\n\n`source_country` is the ISO-2 code of the sender's phone number country.\n\n## Getting help\n\nIf you need help installing or using the library, please check the [FAQ](https://textlinksms.com) first, and contact us at [help@textlinksms.com](mailto://help@textlinksms.com) if you don't find an answer to your question.\n\nIf you've found a bug in the API, package or would like new features added, you are also free to contact us!\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskocimis%2Ftextlink-py","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fskocimis%2Ftextlink-py","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskocimis%2Ftextlink-py/lists"}