This is a Java Client for Infobip API and you can use it as a dependency when you want to consume Infobip APIs in your application. To use this, you'll need an Infobip account. You can create a free trial account here.
infobip-api-java-client is built on top of OpenAPI Specification, generated by Infobip OSCAR service powered by OpenAPI Generator.
Detailed documentation about Infobip API can be found here. The current version of this library includes this subset of Infobip products:
For infobip-api-java-client versioning we use Semantic Versioning scheme.
Published under MIT License.
The library requires Java 11 and is compatible up to and including Java 19.
Simply add the following in your project's POM file under dependencies tag:
<dependency>
<groupId>com.infobip</groupId>
<artifactId>infobip-api-java-client</artifactId>
<version>4.3.2</version>
</dependency>If you decide to take a manual approach, you need the following installed and available in your $PATH:
- JDK 11 or above
- Apache Maven
Proceed with the following:
$ git clone [email protected]:infobip/infobip-api-java-client
$ cd infobip-api-java-client
$ mvn install # Requires maven, download from https://maven.apache.org/download.html
The library supports the API Key Header authentication method. Once you have an Infobip account, you can manage your API keys through the Infobip API key management page.
To see your base URL, log in to the Infobip API Resource hub with your Infobip credentials or visit your Infobip account.
ApiClient apiClient = ApiClient.forApiKey(ApiKey.from(API_KEY))
.withBaseUrl(BaseUrl.from(BASE_URL))
.build();For details, check the ApiClient source code.
See below, a simple example of sending a single SMS message to a single recipient.
SmsApi smsApi = new SmsApi(apiClient);
SmsTextualMessage smsMessage = new SmsTextualMessage()
.from("InfoSMS")
.addDestinationsItem(new SmsDestination().to("41793026727"))
.text("Hello World from infobip-api-java-client!");
SmsAdvancedTextualRequest smsMessageRequest = new SmsAdvancedTextualRequest()
.messages(List.of(smsMessage)); try {
SmsResponse smsResponse = smsApi.sendSmsMessage(smsMessageRequest).execute();
} catch (ApiException apiException) {
// HANDLE THE EXCEPTION
}For asynchronous processing, you can use the following approach:
smsApi.sendSmsMessage(smsMessageRequest)
.executeAsync(new ApiCallback<>() {
@Override
public void onSuccess(SmsResponse result, int responseStatusCode, Map<String, List<String>> responseHeaders) {
// HANDLE THE SUCCESS
}
@Override
public void onFailure(ApiException exception, int responseStatusCode, Map<String, List<String>> responseHeaders) {
// HANDLE THE FAILURE
}
});Fields provided within ApiException object are responseStatusCode referring to a HTTP status code response, as well as the rawResponseBody and details extracted from the response body if possible.
apiException.responseStatusCode();
apiException.rawResponseBody();
apiException.details();Additionally, you can retrieve a bulkId and a messageId from the SmsResponse object to use for troubleshooting or fetching a delivery report for a given message or a bulk.
Bulk ID is received only when you send a message to more than one destination address or send multiple messages in a single request.
String bulkId = smsResponse.getBulkId();
String messageId = smsResponse.getMessages().get(0).getMessageId();For each SMS that you send out, we can send you a message delivery report in real time. All you need to do is specify your endpoint when sending SMS in the notifyUrl field within SmsTextualMessage, or subscribe for reports by contacting our support team at [email protected].
e.g. https://{yourDomain}/delivery-reports
You can use data models from the library and the pre-configured com.infobip.JSON serializer.
Example of webhook implementation with Spring Web framework:
@PostMapping("/delivery-reports")
public void receiveDeliveryReports(HttpServletRequest request) throws IOException {
SmsDeliveryResult reports = new JSON().deserialize(request.getInputStream(), SmsDeliveryResult.class);
for (SmsReport report : reports.getResults()) {
System.out.println(report.getMessageId() + " - " + report.getStatus().getName());
}
}If you prefer to use your own serializer, make note of the supported date format. You can always take a look at our implementation.
If you are for any reason unable to receive real-time delivery reports on your endpoint, you can use messageId or bulkId to fetch them.
Each request will return a batch of delivery reports - only once. See documentation for more details.
SmsDeliveryResult deliveryReports = smsApi.getOutboundSmsMessageDeliveryReports()
.bulkId(bulkId)
.execute();
for (SmsReport report : deliveryReports.getResults()) {
System.out.println(report.getMessageId() + " - " + report.getStatus().getName());
}Infobip API supports Unicode characters and automatically detects encoding. Unicode and non-standard GSM characters use additional space, avoid unpleasant surprises and check how different message configurations will affect your message text, number of characters, and message parts.
SmsPreviewRequest smsPreviewRequest = new SmsPreviewRequest()
.text("Let's see how many characters will remain unused in this message.");
SmsPreviewResponse previewResponse = smsApi
.previewSmsMessage(smsPreviewRequest)
.execute();
System.out.println(previewResponse);If you want to receive SMS messages from your subscribers we can have them delivered to you in real time. When you buy and configure a number capable of receiving SMS, specify your endpoint, as explained in documentation.
e.g. https://{yourDomain}/incoming-sms.
Example of webhook implementation with Spring Web framework:
@PostMapping("/incoming-sms")
public void receiveSms(HttpServletRequest request) throws IOException {
SmsInboundMessageResult messages = new JSON().deserialize(request.getInputStream(), SmsInboundMessageResult.class);
for (SmsInboundMessage message : messages.getResults()) {
System.out.println(message.getFrom() + " - " + message.getCleanText());
}
}For 2FA quick start guide, view these examples.
For Email quick start guide, view these examples.
For WhatsApp quick start guide, view these examples.
For Messages API quick start guide, view these examples.
Feel free to open issues on the repository for any encountered problem or feature request. For pull requests, go to the CONTRIBUTING file related to it. This code is auto generated, and we are unable to merge any pull requests form here.
This code is auto generated, and we are unable to merge any pull request from here, but we will review and implement changes directly within our pipeline, as described in the CONTRIBUTING file.
For anything that requires our imminent attention, contact us @ [email protected].