{"id":37416077,"url":"https://github.com/nimbasms/nimbasms-java","last_synced_at":"2026-01-16T06:01:41.801Z","repository":{"id":65765588,"uuid":"589670799","full_name":"nimbasms/nimbasms-java","owner":"nimbasms","description":"A Java module for communicating with Nimba SMS API. ","archived":false,"fork":false,"pushed_at":"2025-08-08T04:45:11.000Z","size":90,"stargazers_count":3,"open_issues_count":0,"forks_count":5,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-08-08T06:27:21.220Z","etag":null,"topics":["java-client-sdk","sms","sms-api"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nimbasms.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}},"created_at":"2023-01-16T16:57:40.000Z","updated_at":"2025-08-08T04:45:15.000Z","dependencies_parsed_at":null,"dependency_job_id":"826c0733-a9c5-4f52-a5ca-c3edc27087de","html_url":"https://github.com/nimbasms/nimbasms-java","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/nimbasms/nimbasms-java","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nimbasms%2Fnimbasms-java","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nimbasms%2Fnimbasms-java/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nimbasms%2Fnimbasms-java/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nimbasms%2Fnimbasms-java/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nimbasms","download_url":"https://codeload.github.com/nimbasms/nimbasms-java/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nimbasms%2Fnimbasms-java/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28477585,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-16T03:13:13.607Z","status":"ssl_error","status_checked_at":"2026-01-16T03:11:47.863Z","response_time":107,"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":["java-client-sdk","sms","sms-api"],"created_at":"2026-01-16T06:00:53.998Z","updated_at":"2026-01-16T06:01:41.775Z","avatar_url":"https://github.com/nimbasms.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# nimbasms-java\n\nA Java module for communicating with the **Nimba SMS API**.\n\n[![](https://jitpack.io/v/nimbasms/nimbasms-java.svg)](https://jitpack.io/#nimbasms/nimbasms-java)\n\n---\n\n## Table of Contents\n\n- [Installation](#installation)\n- [JitPack Setup](#jitpack-setup)\n- [Credentials Setup](#credentials-setup)\n- [Usage](#usage)\n    - [Access Token](#access-token)\n    - [Accounts](#accounts)\n    - [Groups](#groups)\n    - [Sender Names](#sender-names)\n    - [Contacts](#contacts)\n    - [Messages](#messages)\n    - [Purchases](#purchases)\n\n---\n\n## \u003ca name=\"installation\"\u003e\u003c/a\u003e Installation\n\n### System Requirements\n- JDK 11 or higher.\n- subscription via Nimba SMS Partner portal\n\n- Java 11 or higher\n- Subscription via [Nimba SMS Partner Portal](https:///www.nimbasms.com)\n\n### Maven (Default - Maven Central)\n### Add Maven Dependency\nIf you use Maven, add the following configuration to your project's `pom.xml`\n```maven\n\u003cdependency\u003e\n  \u003cgroupId\u003ecom.nimbasms\u003c/groupId\u003e\n  \u003cartifactId\u003enimbasms\u003c/artifactId\u003e\n  \u003cversion\u003e0.0.1\u003c/version\u003e\n\u003c/dependency\u003e\n```\n## \u003ca name=\"jitpack-setup\"\u003e\u003c/a\u003e JitPack Setup\n\u003e ⚠️ If the package is not yet on Maven Central, you can use JitPack\n\n```xml\n\u003crepositories\u003e\n  \u003crepository\u003e\n  \u003cid\u003ejitpack.io\u003c/id\u003e\n  \u003curl\u003ehttps://jitpack.io\u003c/url\u003e\n  \u003c/repository\u003e\n\u003c/repositories\u003e\n```\n### Add Dependency\nUsing the latest release tag (recommended):\n\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.github.nimbasms\u003c/groupId\u003e\n    \u003cartifactId\u003enimbasms-java\u003c/artifactId\u003e\n    \u003cversion\u003ev0.0.1\u003c/version\u003e \u003c!-- Replace with the latest tag --\u003e\n\u003c/dependency\u003e\n```\nIf no release exists:\n\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.github.nimbasms\u003c/groupId\u003e\n    \u003cartifactId\u003enimbasms-java\u003c/artifactId\u003e\n    \u003cversion\u003emaster-SNAPSHOT\u003c/version\u003e \u003c!-- Or use commit hash --\u003e\n\u003c/dependency\u003e\n```\n## Configuration of Credentials\n\nBefore instantiating a `NimbaSMSClient` object, ensure you have the required credentials. Obtain these credentials (ACCOUNT_SID and AUTH_TOKEN) from your SMS service provider.\n\n```java\nString ACCOUNT_SID = \"Your_ACCOUNT_SID\";\nString AUTH_TOKEN = \"Your_AUTH_TOKEN\";\n```\n\n## \u003ca name=\"accesToken\"\u003e\u003c/a\u003e Get your Access token\n```java\nimport com.nimbasms.nimbasms.NimbaSMSClient;\n\nNimbaSMSClient client = new NimbaSMSClient(ACCOUNT_SID, AUTH_TOKEN)\n```\n\n## \u003ca name=\"account\"\u003e\u003c/a\u003e Accounts\nRetrieve the account information using the getAccount() method:\n```java\nAccountResponse account = client.getAccount().get();\nSystem.out.println(account);\n```\nCheck balance\n```java\nAccountResponse account = client.getAccount().get();\nSystem.out.println(account.getBalance());\n```\n\n## \u003ca name=\"group\"\u003e\u003c/a\u003e Groups\nThis code retrieves a list of all groups.\n```java\nGroupResponse groups = client.getGroup().list();\nSystem.out.println(groups);\n```\n\nYou can also retrieve the last 10 Group by passing in the limit and offset:\n```java\nGroupResponse last10groups = client.getGroup().list(10, 1);\nSystem.out.println(last10groups);\n```\nThe next method returns the next item in a list.\n```java\nGroupResponse nextGroups = client.getGroup().next();\nSystem.out.println(nextGroups);\n```\nThe previous method returns the previous item in the list.\n```java\nGroupResponse previousGroups = client.getGroup().previous();\nSystem.out.println(previousGroups);\n```\n\n## \u003ca name=\"sendername\"\u003e\u003c/a\u003e Sendernames\nRetrieve the sender names using the getSenderName() method:\n\n```java\nSenderNameResponse senderNames = client.getSenderName().list();\nSystem.out.println(senderNames);\n```\nYou can also retrieve the last 10 sender names by passing in the limit and offset:\n\n```java\nSenderNameResponse last10SenderNames = client.getSenderName().list(10, 1);\nSystem.out.println(last10SenderNames);\n```\n\nThe next method returns the next item in a list.\n\n```java\nSenderNameResponse nextSenderNames = client.getSenderName().next();\nSystem.out.println(nextSenderNames);\n```\nThe previous method returns the previous item in the list.\n\n```java\nSenderNameResponse previousSenderNames = client.getSenderName().previous();\nSystem.out.println(previousSenderNames);\n```\n\n## \u003ca name=\"contact\"\u003e\u003c/a\u003e Contacts\nThis code retrieves a list of all contacts.\n```java\nContactResponse contacts = client.getContact().list();\nSystem.out.println(contacts);\n```\nYou can also retrieve the last 10 contacts by passing in the limit and offset:\n```java\nContactResponse last10contacts = client.getContact().list(10, 1);\nSystem.out.println(last10contacts);\n```\nThe next method returns the next item in a list.\n```java\nContactResponse nextContacts = client.getContact().next();\nSystem.out.println(nextContacts);\n```\nThe previous method returns the previous item in the list.\n```java\nContactResponse previousContacts = client.getContact().previous();\nSystem.out.println(previousContacts);\n```\n\nCreate Contact. This contact will be added to the default contact list:\n```java\nContactDto createContactResponse = client.getContact().create(\"+224XXXXXXXXX\", null, null);\nSystem.out.println(createContactResponse)\n```\nCreate with groups and name - name and groups are optional.\n```java\nContactDto contactResponseWithGroupsAndName = client.getContact().create(\"+224XXXXXXXXX\", \"Foo\", List.of(\"API\", \"Facebook Client\"));\nSystem.out.println(contactResponseWithGroupsAndName);\n```\n\n## \u003ca name=\"message\"\u003e\u003c/a\u003e Messages\nGet All messages\n```java\nMessageResponse messages = client.getMessage().list();\nSystem.out.println(messages);\n```\nGet only last 10 messages\n```java\nMessageResponse last10Messages = client.getMessage().list(10, 1);\nSystem.out.println(last10Messages);\n```\nThe next method returns the next item in a list.\n```java\nMessageResponse nextMessages = client.getMessage().next();\nSystem.out.println(nextMessages);\n```\nThe previous method returns the previous item in the list.\n```java\nMessageResponse previousMessages = client.getMessage().previous();\nSystem.out.println(previousMessages);\n```\n\nSend a message\n```java\nMessageResponse messageResponse = client.getMessage().create(\"sender_name\", List.of(\"+224XXXXXXXXX\"), \"Hello nimba\");\nSystem.out.println(messageResponse);\n```\nRetrieve message\n```java\nMessageDetails messageDetails = client.getMessage().retrieve(\"123\");\nSystem.out.println(messageDetails);\n```\n\n## \u003ca name=\"purchase\"\u003e\u003c/a\u003e Purchases\nList all purchases\n```java\nPurchaseResponse purchases = client.getPurchase().list();\n```\nRetrieve the last 10 purchases\n```java\nPurchaseResponse last10Purchases = client.getPurchase().list(10, 1);\n```\nThe next method returns the next item in a list.\n```java\nPurchaseResponse nextPurchases = client.getPurchase().next();\n```\nThe previous method returns the previous item in a list.\n```java\nPurchaseResponse previousPurchases = client.getPurchase().previous();\n```\n---\n\n## License\n\nThis project is licensed under the MIT License – see the [LICENSE](LICENSE) file for details.\n\n---\n\n## Author \u0026 Contributions\n\nContributions to the official Java client for [Nimba SMS](https://nimbasms.com)\n\n\u003e 💡 Feel free to open issues or pull requests to improve the SDK.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnimbasms%2Fnimbasms-java","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnimbasms%2Fnimbasms-java","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnimbasms%2Fnimbasms-java/lists"}