com.tomtom.speedtools.services.sms.implementation.messagebird

Interface MessageBirdResource

All Known Implementing Classes:

MessageBirdResourceMock

@Path(value="/api/sms")
 @Consumes(value="application/xml")
 @Produces(value="application/xml")
public interface MessageBirdResource

Resteasy resource to call the MessageBird REST api. Currently only supports sending simple text messages. timestamp and inbox have been omitted from this api (they are optional). The baseUrl can be obtained using the property SMSProvider.MessageBird.baseUrl.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MessageBirdResource.ResponseType

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	sendMessage(String userName, String password, Long reference, String sender, String destination, String body, MessageBirdResource.ResponseType responseType, String replaceChars) This operation sends an SMS text message using MessageBird.

Method Detail

sendMessage

@GET
javax.ws.rs.core.Response sendMessage(@Nonnull @QueryParam(value="username")
                                           String userName,
                                           @Nonnull @QueryParam(value="password")
                                           String password,
                                           @Nullable @QueryParam(value="reference")
                                           Long reference,
                                           @Nonnull @QueryParam(value="sender")
                                           String sender,
                                           @Nonnull @QueryParam(value="destination")
                                           String destination,
                                           @Nonnull @QueryParam(value="body")
                                           String body,
                                           @Nonnull @QueryParam(value="responsetype")
                                           MessageBirdResource.ResponseType responseType,
                                           @Nullable @QueryParam(value="replaceChars")
                                           String replaceChars)

This operation sends an SMS text message using MessageBird.

Parameters:

userName - Username of messageBird account.

password - Password of MessageBird account.

reference - Unique reference between 1 and 20 digits.

sender - The number of the sender. Since inbox is omitted, this field is compulsory.

destination - Recipient as MSISDN encoded number (i.e., without +, and 00).

body - Body of the text message (with a maximum length of 670 characters), UTF-8 encoded.

responseType - Response type.

replaceChars - Replace characters with GSM7 equivalents. Optional, default true.

Returns:

Response.