{"id":19540784,"url":"https://github.com/skocimis/textlink-js","last_synced_at":"2026-05-01T21:02:20.686Z","repository":{"id":225242779,"uuid":"765461842","full_name":"Skocimis/textlink-js","owner":"Skocimis","description":"Library for Node.js that helps you send SMS and verify users using the TextLink API","archived":false,"fork":false,"pushed_at":"2024-03-02T17:57:01.000Z","size":7,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-20T15:56:32.675Z","etag":null,"topics":["api","api-client","bulk-sms","javascript","nodejs","simple-sms","sms","sms-api","sms-gateway","sms-verification","text-message","typescript","user-verification"],"latest_commit_sha":null,"homepage":"https://textlinksms.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","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,"publiccode":null,"codemeta":null}},"created_at":"2024-03-01T00:51:05.000Z","updated_at":"2024-03-08T00:01:30.000Z","dependencies_parsed_at":"2024-03-01T01:25:48.994Z","dependency_job_id":"800e9086-9cdf-4a02-9773-c321140aa582","html_url":"https://github.com/Skocimis/textlink-js","commit_stats":null,"previous_names":["skocimis/textlink-js"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Skocimis/textlink-js","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Skocimis%2Ftextlink-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Skocimis%2Ftextlink-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Skocimis%2Ftextlink-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Skocimis%2Ftextlink-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Skocimis","download_url":"https://codeload.github.com/Skocimis/textlink-js/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Skocimis%2Ftextlink-js/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32512670,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-30T13:12:12.517Z","status":"online","status_checked_at":"2026-05-01T02:00:05.856Z","response_time":64,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","javascript","nodejs","simple-sms","sms","sms-api","sms-gateway","sms-verification","text-message","typescript","user-verification"],"created_at":"2024-11-11T03:06:53.084Z","updated_at":"2026-05-01T21:02:20.670Z","avatar_url":"https://github.com/Skocimis.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# TextLink Node.js helper library\n\n[![NPM](https://nodei.co/npm/textlink-sms.png?downloads=true\u0026stars=true)](https://www.npmjs.com/package/textlink-sms)\n\n### Supported Node.js Versions\n* Node.js 18\n* Node.js 20\n* Node.js 21\n* Node.js 22\n\n## Installation\n`npm install textlink-sms` or `yarn add textlink-sms`\n\n## Sending an SMS\n\nTo send an SMS, you have to create an API key using the [TextLink API Console](https://textlinksms.com/dashboard/api). When you register an account, you automatically get an API key with 0.5$ of credits (for TextLink service) and 500 free messages (for [Use your device](https://docs.textlinksms.com/send-sms-through-your-phone) service).\n\n### Just send a message\n\n```javascript\nconst textlink = require(\"textlink-sms\");\ntextlink.useKey(\"YOUR_API_KEY\"); //You can create one in the API Console at https://textlinksms.com/dashboard/api\n\ntextlink.sendSMS(\"+381611231234\", \"Dummy message text...\");\n```\n\n### Handle response\n\n```javascript\nasync function async_function() {\n  let result = await textlink.sendSMS(\"+381611231234\", \"Dummy message text...\");\n  console.log(result);\n}\nasync_function();\n```\n\n### Example of the result of a successfully sent message\n\n```json\n{\n    \"ok\": true\n}\n```\n\n### Example of the result of an 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```js\n//User has sent his phone number for verification\nawait textlink.sendVerificationSMS(\"+11234567890\", verificationOptions);\n\n//Show him the code submission form\n//We will handle the verification code ourselves\n\n//The user has submitted the code\nconst result = await textlink.verifyCode(\"+11234567890\", \"USER_ENTERED_CODE\"); \n//if `result.ok` is true, then the phone number is verified. \n```\n\n#### Verification options\n\n`VerificationOptions` the optional argument for the `sendVerificationSMS` function. It contains the parameters of the verification code that should be sent:\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```javascript\n{\n  service_name: \"Guest\",\n  expiration_time: 10 * 60 * 1000,\n  source_country: \"US\"\n}\n```\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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskocimis%2Ftextlink-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fskocimis%2Ftextlink-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskocimis%2Ftextlink-js/lists"}