{"id":38581305,"url":"https://github.com/abduljeleelng/termii-nodejs-sdk","last_synced_at":"2026-01-17T08:15:50.218Z","repository":{"id":41136779,"uuid":"508448235","full_name":"abduljeleelng/termii-nodejs-sdk","owner":"abduljeleelng","description":"Node js SDK for the Termii messages(SMS) and one time password (OTP) services. User verification through the mobile number, In App Authentication, Voice Token, Call token, and Authentication services","archived":false,"fork":false,"pushed_at":"2022-08-08T22:28:56.000Z","size":307,"stargazers_count":2,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-05T08:55:53.903Z","etag":null,"topics":["authentication","calls","tokens","voice"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/termii-nodejs-sdk","language":"TypeScript","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/abduljeleelng.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}},"created_at":"2022-06-28T20:42:20.000Z","updated_at":"2023-11-09T12:25:41.000Z","dependencies_parsed_at":"2022-08-25T17:24:06.499Z","dependency_job_id":null,"html_url":"https://github.com/abduljeleelng/termii-nodejs-sdk","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/abduljeleelng/termii-nodejs-sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abduljeleelng%2Ftermii-nodejs-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abduljeleelng%2Ftermii-nodejs-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abduljeleelng%2Ftermii-nodejs-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abduljeleelng%2Ftermii-nodejs-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/abduljeleelng","download_url":"https://codeload.github.com/abduljeleelng/termii-nodejs-sdk/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abduljeleelng%2Ftermii-nodejs-sdk/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28504359,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T06:57:29.758Z","status":"ssl_error","status_checked_at":"2026-01-17T06:56:03.931Z","response_time":85,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["authentication","calls","tokens","voice"],"created_at":"2026-01-17T08:15:50.115Z","updated_at":"2026-01-17T08:15:50.195Z","avatar_url":"https://github.com/abduljeleelng.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\n\n\u003c!-- [![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/abduljeleelng/#readme) :joy: 💖\n![npm bundle size](https://img.shields.io/bundlephobia/min/termii?color=yellow\u0026label=Termii\u0026logo=awsome)\n[![issue]](https://img.shields.io/github/issues/abduljeleelng/termii-nodejs-sdk?label=issues)\n--\u003e\n\n\n\u003cimg src=\"icon.png\" align=\"right\" /\u003e\n\n# [termii-nodejs-sdk](https://developers.termii.com/)\n### Node js SDK for the Termii messages (SMS) and one time password (OTP) services\n## Introduction\n\u003e  These docs will give you a deep dive into Termii Nodejs SDK full  API Reference Documentation and how to seamlessly integrate Termii messaging channels and verification functionalities into [NodeJS](https://nodejs.org/) application.\n\u003e For more details about the [Termii services](https://developers.termii.com/)\n\n## Installation\n\nUse need [NodeJS](https://nodejs.org/) or [yarn](https://yarnpkg.com) package manager to use this SDK with your nodejs application.\nNote: all the instance return promise.\n\n```bash\nnpm install termii-nodejs-sdk\n```\nor\n\n```bash\nyarn add termii-nodejs-sdk\n```\n# Get your api key\n\u003e create an account at [termii.com](termii.com).\n\u003e - login to your account\n\u003e - click on the setting\n\u003e - click on the API Token\n\u003e - copy your API Key\n\u003e - the image bellow can guid you more\n     ![termii API console!](termiiapi.png \"API cosole\")\n\u003e\n\u003e\n# Basic\n```bash\n#\nimport Termii from \"termii-nodejs-sdk\"\n\n#es5\nconst Termii = require(\"termii-nodejs-sdk\").default\n\n#usage \nconst termii = new Termii(\"your API Key\")\n\n#Get your account balance \nlet balance = termii.balance(); #balance will return a promise\nbalance.then(data=\u003e{\n    console.log(JSON.stringify({data}))\n})\n\n#Or\ntermii.balance().then(data=\u003e{console.log({data})}).catch(err=\u003e{console.log({err})})\n\n#Or\n (async () =\u003e {\n     balance = await termii.balance();\n     console.log(JSON.stringify({balance}))\n })()\n \n # Request for A token \n termii.token({\n    message_type: \"NUMERIC\",\n    to: \"2348037.........\",\n    from: \"Token\",\n    channel: \"generic\",\n    pin_attempts: 4,\n    pin_time_to_live: 4,\n    pin_length: 6,\n    pin_placeholder: \"\u003c 123456 \u003e\",\n    message_text: \"Your (company name) confirmation code is \u003c 123456 \u003e. It expires in 30 minutes\",\n    \"pin_type\":\"NUMERIC\"\n}).then(dat=\u003econsole.log({dat})).catch(er=\u003econsole.log({er}));\n```\n\n# Available Services\n```\n #\nimport Termii from \"termii-nodejs-sdk\"\n\n#es5\nconst Termii = require(\"termii-nodejs-sdk\").default\n\n#usage \nconst termii = new Termii(\"your API Key\")\n ```\n\n[`termii.getSenderId()` Get all the your available sender id ](docs/senderId.md)\n\n[`termii.requestSenderId({sender_id,usecase,company})` Request for a new sender Id ](docs/requestSenderId.md)\n\n[`termii.sendSMS({to,from,sms,type,channel,media})` Send SMS ]()\n\n[`termii.bulkSMS({to,from,sms,type,channel})` Send bulk SMS ]()\n\n[`termii.message({to,sms})` Send message | Number API ]()\n\n[`termii.template({phone_number,device_id,template_id,data:{product_name,opt,expiry_time}})` Template ]()\n\n[`termii.phoneBook()` Get phone book ]()\n\n[`termii.createPhoneBook({phonebook_id,phonebook_name,description})` create phone book ]()\n \n[`termii.updatePhoneBook({phonebook_id,phonebook_name,description})` update phone book ]()\n\n[`termii.deletePhoneBook({phonebook_id})` Delete phone book ]()\n\n[`termii.contact({phonebook_id})` get all the contact ]()\n\n[`termii.addContact({phonebook_id,phone_number,country_code,email_address,first_name,last_name,company})` Add contact ]()\n\n[`termii.addBulkContact({phonebook_id,contact_file,country_code})` Add bulk Contact ]()\n\n[`termii.deleteContact({contact_id})` delete contact ]()\n\n[`termii.campaign({country_code,sender_id,message,channel,message_type,phonebook_id,campaign_type,schedule_sms_status,schedule_time})` Campaign ]()\n\n[`termii.campaignList()` Campaign List ]()\n\n[`termii.campaignHistory({campaign_id})` Campaign Hostory ]()\n\n[`termii.token({message_type,to,from,channel,pin_attempts,pin_time_to_live,pin_length,pin_placeholder,message_text})` Token | OTP ]()\n\n[`termii.voiceToken({pin_type,phone_number,pin_attempts,pin_time_to_live,pin_length})` Voice Token]()\n\n[`termii.callToken({phone_number,code})` call token | OTP ]()\n\n[`termii.inAppToken({pin_type,phone_number,pin_attempts,pin_time_to_live,pin_length})` In App Token ]()\n\n[`termii.verifyToken({pin_id,pin})` Verify Token ]()\n\n[`termii.balance()` get account balance ]()\n\n[`termii.search({phone_number})` search ]()\n\n[`termii.status({ phone_number:\", country_code:\"})` status ]()\n\n[`termii.history()` history ]()\n\n\n\n## Report issues here 💔\n[Termii nodejs SDK issue](https://github.com/abduljeleelng/termii-nodejs-sdk/issues)\n\n## Documentation\n[Termi services](https://termii.com)\n\n## Todo \n- Create more sample to consume all the services \n- create more details in the documentation\n- add more validation to the payload and response\n- write an article about the services\n\n\n## Contact Me\n[Abduljeleel Yusuff]\u003cmailto:abduljeleelng@gmail.com\u003e \n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fabduljeleelng%2Ftermii-nodejs-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fabduljeleelng%2Ftermii-nodejs-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fabduljeleelng%2Ftermii-nodejs-sdk/lists"}