{"id":15723080,"url":"https://github.com/ikifar2012/voip.ms-node.js-example","last_synced_at":"2026-01-21T16:31:20.680Z","repository":{"id":207102879,"uuid":"718438541","full_name":"ikifar2012/VoIP.ms-Node.js-Example","owner":"ikifar2012","description":"This project is a simple implementation of the VoIP.ms SMS API. It allows you to send SMS messages and host a web server for incoming SMS messages.","archived":false,"fork":false,"pushed_at":"2025-03-20T02:47:02.000Z","size":39,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-20T03:36:58.615Z","etag":null,"topics":["rest-api","sms","sms-api","voip","voip-ms"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ikifar2012.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2023-11-14T04:25:20.000Z","updated_at":"2025-03-20T02:48:50.000Z","dependencies_parsed_at":"2024-08-14T04:14:46.851Z","dependency_job_id":"30151c1f-685d-496e-911d-5d7e6058040f","html_url":"https://github.com/ikifar2012/VoIP.ms-Node.js-Example","commit_stats":null,"previous_names":["ikifar2012/voip.ms-node.js-example"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ikifar2012%2FVoIP.ms-Node.js-Example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ikifar2012%2FVoIP.ms-Node.js-Example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ikifar2012%2FVoIP.ms-Node.js-Example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ikifar2012%2FVoIP.ms-Node.js-Example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ikifar2012","download_url":"https://codeload.github.com/ikifar2012/VoIP.ms-Node.js-Example/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247615483,"owners_count":20967183,"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":["rest-api","sms","sms-api","voip","voip-ms"],"created_at":"2024-10-03T22:10:16.149Z","updated_at":"2026-01-21T16:31:20.637Z","avatar_url":"https://github.com/ikifar2012.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# VoIP.ms SMS API\n\nThis project is a simple implementation of the VoIP.ms SMS API. It allows you to send SMS messages and host a web server for incoming SMS messages.\n\n*Please note that this implementation of the API is not complete and is intended for demonstration purposes only*\n\nFor more information on the VoIP.ms SMS API, see the [official documentation](https://voip.ms/m/apidocs.php).\n\n## Getting Started\n\nThese instructions will get you a copy of the project up and running on your local machine for development and testing purposes.\n\n### Prerequisites\n\nYou need to have Node.js and npm installed on your machine. \n\n### Installing\n\n1. Clone the repository\n2. Install the dependencies using npm:\n\n```bash\nnpm install\n```\n\n### Configuration\n\nCreate a `env.js` file in the root directory of the project, and insert your API credentials:\n\n```javascript\nmodule.exports = {\n    API_PASSWORD: 'your-api-password',\n    API_USER: 'your-api-username',\n    DID: 'your-did',\n    API_KEY: 'your-api-key'\n};\n```\n| Variable    | Description                                                                                          |\n|-------------|------------------------------------------------------------------------------------------------------|\n| `API_PASSWORD`| Set in the VoIP.ms control panel under `Main Menu \u003e SOAP / REST API \u003e API Security`.                 |\n| `API_USER`    | The username/e-mail you use to log in to the VoIP.ms control panel.                                         |\n| `DID`         | The phone number you want to send SMS messages from.                                                  |\n| `API_KEY`     | A random string of characters that you use to authenticate incoming SMS messages in the SMS Callback URL. |\n\nYou can generate a random string of characters using the following command:\n\n```bash\nopenssl rand -hex 32\n```\n\n\n\n## Running the Server\n\nStart the server by running:\n\n```bash\nnode index.js\n```\n\nThe server will start on port 3000.\n\n## Usage\n\nTo send an SMS, call the `sendSMS` function with the destination phone number and the message:\n\n```javascript\nsendSMS('5555555555', 'Hello, world!');\n```\n\nTo receive an SMS, VoIP.ms will send a GET request to `https://example.com/sms` with the following query parameters: `to`, `from`, `message`, `files`, `id`, `date`, and `api_key`.\n\nVia the SMS Callback URL in the VoIP.ms control panel, you can set the URL to:\n```\nhttps://example.com/sms?to={TO}\u0026from={FROM}\u0026message={MESSAGE}\u0026files={MEDIA}\u0026id={ID}\u0026date={TIMESTAMP}?api_key=your-api-key\n```\n\nVoIP.ms will replace the query parameters with the appropriate values.\n\n## Support\nIf you found this project helpful, please consider using my [referral link](https://voip.ms/en/invite/Mzg1ODYz) to sign up for VoIP.ms. I will receive a small commission at no extra cost to you.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fikifar2012%2Fvoip.ms-node.js-example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fikifar2012%2Fvoip.ms-node.js-example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fikifar2012%2Fvoip.ms-node.js-example/lists"}