MessageBirdClient (com.messagebird:messagebird-api 6.2.1 API)

java.lang.Object
- com.messagebird.MessageBirdClient

public class MessageBirdClient
extends Object

Message bird general client

 Initialise this class with a MessageBirdService
  // First create your service object
  MessageBirdService wsr = new MessageBirdServiceImpl(args[0]);
  // Add the service to the client
  MessageBirdClient messageBirdClient = new MessageBirdClient(wsr);

  Then read your balance like this:
  final Balance balance = messageBirdClient.getBalance();

Created by rvt on 1/5/15.

Constructor Summary

Constructors
Constructor and Description

MessageBirdClient(MessageBirdService messageBirdService)

Constructors
Constructor and Description
`MessageBirdClient(MessageBirdService messageBirdService)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cancelNumber(String number)` Cancels a particular number.
`ChildAccountCreateResponse`	`createChildAccount(ChildAccountRequest childAccountRequest)` Function to create a child account
`TranscriptionResponse`	`createTranscription(String callID, String legId, String recordingId, String language)` Function to view recording by call id , leg id and recording id
`WebhookResponseData`	`createWebhook(Webhook webhook)` Function to create a webhook
`TemplateResponse`	`createWhatsAppTemplate(Template template)` Create a WhatsApp message template through messagebird.
`void`	`deleteChildAccount(String id)` Function to delete a child account
`void`	`deleteConversationWebhook(String webhookId)` Deletes a webhook.
`void`	`deleteGroup(String id)` Deletes an existing group.
`void`	`deleteGroupContact(String groupId, String contactId)` Removes a contact from group.
`void`	`deleteMessage(String id)` Delete a message from the Messagebird server
`void`	`deleteRecording(String callID, String legID, String recordingID)` Deletes a voice recording
`void`	`deleteTemplatesBy(String templateName)` Delete templates of an existing template name.
`void`	`deleteVerifyObject(String id)`
`void`	`deleteVoiceCall(String id)` Function to delete voice call by id
`void`	`deleteVoiceCallFlow(String id)` Convenient function to delete call flow
`void`	`deleteVoiceMessage(String id)` Delete a voice message from the Messagebird server
`void`	`deleteWebhook(String id)` Function to delete a webhook
`String`	`downloadFile(String id, String filename, String basePath)` Downloads a file and stores it with the provided filename in the basePath directory.
`String`	`downloadRecording(String callID, String legId, String recordingId, String basePath)` Downloads the record in .wav format by using callId, legId and recordId and stores to basePath.
`String`	`downloadTranscription(String callID, String legId, String recordingId, String transcriptionId, String basePath)` Downloads the transcription in .txt format by using callId, legId, recordId and transcriptionId and stores to basePath.
`TemplateResponse`	`fetchWhatsAppTemplateBy(String templateName, String language)` Retrieves the template of an existing template name and language under the first waba connected to the requesting user.
`TemplateResponse`	`fetchWhatsAppTemplateBy(String templateName, String language, String wabaID, String channelID)` Retrieves the template of an existing template name and language under a WABA or for a channel.
`Balance`	`getBalance()` MessageBird provides an API to get the balance information of your account.
`ChildAccountDetailedResponse`	`getChildAccountById(String id)` Function to get a child account
`List<ChildAccountResponse>`	`getChildAccounts(Integer offset, Integer limit)` Function to get a child account
`OutboundSmsPriceResponse`	`getOutboundSmsPrices()` Returns outbound pricing for the default SMS configuration for the authenticated account.
`OutboundSmsPriceResponse`	`getOutboundSmsPrices(String smppUsername)` Returns outbound SMS pricing for a specific SMPP username.
`Hlr`	`getRequestHlr(BigInteger msisdn, String reference)` MessageBird provides an API to send Network Queries to any mobile number across the world.
`VerifyMessage`	`getVerifyEmailMessage(String messageId)`
`Verify`	`getVerifyObject(String id)`
`Hlr`	`getViewHlr(String hlrId)` Retrieves the information of an existing HLR.
`List<TemplateResponse>`	`getWhatsAppTemplatesBy(String templateName)` Retrieves the template of an existing template name.
`List<TemplateResponse>`	`getWhatsAppTemplatesBy(String templateName, String wabaID, String channelID)` Retrieves the template of an existing template name.
`VoiceCallResponseList`	`listAllVoiceCalls(Integer page, Integer pageSize)` Function to list all voice calls
`ContactList`	`listContacts()` Gets a contact listing with default pagination options.
`ContactList`	`listContacts(int offset, int limit)` Gets a contact listing with specified pagination options.
`ConversationMessageList`	`listConversationMessages(String conversationId)` Gets a ConversationMessage listing with default pagination options.
`ConversationMessageList`	`listConversationMessages(String conversationId, int offset, int limit)` Gets a ConversationMessage listing with specified pagination options.
`ConversationMessageList`	`listConversationMessagesWithQueryParam(Map<String,Object> queryParams)` Gets conversation messages based on query param.
`ConversationList`	`listConversations()` Gets a contact listing with default pagination options.
`ConversationList`	`listConversations(int offset, int limit)` Gets a Conversation listing with specified pagination options.
`ConversationWebhookList`	`listConversationWebhooks()` Gets a ConversationWebhook listing with default pagination options.
`ConversationWebhookList`	`listConversationWebhooks(int offset, int limit)` Gets a ConversationWebhook listing with the specified pagination options.
`GroupList`	`listGroups()` Gets a contact listing with default pagination options.
`GroupList`	`listGroups(int offset, int limit)` Gets a contact listing with specified pagination options.
`MessageList`	`listMessages(Integer offset, Integer limit)`
`MessageList`	`listMessagesFiltered(Integer offset, Integer limit, Map<String,Object> filters)`
`PhoneNumbersResponse`	`listNumbersForPurchase(String countryCode)` Lists Numbers that are available to purchase in a particular country code, without any filters.
`PhoneNumbersResponse`	`listNumbersForPurchase(String countryCode, PhoneNumbersLookup params)` Lists Numbers that are available to purchase in a particular country code, according to specified search criteria.
`PurchasedNumbersResponse`	`listPurchasedNumbers(PurchasedNumbersFilter filter)` Lists Numbers that were purchased using the account credentials that the client was initialized with.
`RecordingResponse`	`listRecordings(String callID, String legId, Integer offset, Integer limit)` List the all recordings related to CallID and LegId
`TranscriptionResponse`	`listTranscriptions(String callID, String legId, String recordingId, Integer page, Integer pageSize)` Lists the Transcription of callId, legId and recordId
`VoiceCallFlowList`	`listVoiceCallFlows(Integer offset, Integer limit)` Convenient function to list all call flows
`VoiceMessageList`	`listVoiceMessages(Integer offset, Integer limit)` List voice messages
`WebhookList`	`listWebhooks(Integer offset, Integer limit)` Function to list webhooks
`TemplateList`	`listWhatsAppTemplates()` Gets a template listing with default pagination options.
`TemplateList`	`listWhatsAppTemplates(int offset, int limit)` Gets a WhatsAppTemplate listing with specified pagination options.
`TemplateList`	`listWhatsAppTemplates(int offset, int limit, String wabaID, String channelID)` Gets a WhatsAppTemplate listing with specified pagination options and a wabaID or channelID filter.
`PurchasedNumberCreatedResponse`	`purchaseNumber(String number, String countryCode, int billingIntervalMonths)` Purchases a phone number.
`LookupHlr`	`requestLookupHlr(BigInteger phoneNumber, String reference)` Request a Lookup HLR (lookup)
`LookupHlr`	`requestLookupHlr(LookupHlr lookupHlr)` Request a Lookup HLR (lookup)
`Contact`	`sendContact(ContactRequest contactRequest)` Creates a new contact object.
`ConversationMessage`	`sendConversationMessage(String conversationId, ConversationMessageRequest request)` Sends a message to an existing Conversation.
`ConversationWebhook`	`sendConversationWebhook(ConversationWebhookCreateRequest request)` Creates a new webhook.
`MessageResponse`	`sendFlashMessage(String originator, String body, List<BigInteger> recipients)` Convenient function to send a simple flash message to a list of recipients
`MessageResponse`	`sendFlashMessage(String originator, String body, List<BigInteger> recipients, String reference)` Convenient function to send a simple flash message to a list of recipients
`Group`	`sendGroup(GroupRequest groupRequest)` Creates a new group object.
`void`	`sendGroupContact(String groupId, String[] contactIds)` Adds contact to group.
`ConversationSendResponse`	`sendMessage(ConversationSendRequest request)` sendMessage allows you to send message to users over any communication platform supported by Programmable Conversations
`MessageResponse`	`sendMessage(Message message)` Send a message through the messagebird platform
`MessageResponse`	`sendMessage(String originator, String body, List<BigInteger> recipients)` Convenient function to send a simple message to a list of recipients
`MessageResponse`	`sendMessage(String originator, String body, List<BigInteger> recipients, String reference)` Convenient function to send a simple message to a list of recipients
`Verify`	`sendVerifyToken(String recipient)`
`Verify`	`sendVerifyToken(VerifyRequest verifyRequest)`
`VoiceCallResponse`	`sendVoiceCall(VoiceCall voiceCall)` Function for voice call to a number
`VoiceCallFlowResponse`	`sendVoiceCallFlow(VoiceCallFlowRequest voiceCallFlowRequest)` Convenient function to create a call flow
`VoiceMessageResponse`	`sendVoiceMessage(String body, List<BigInteger> recipients)` Convenient function to send a simple message to a list of recipients
`VoiceMessageResponse`	`sendVoiceMessage(String body, List<BigInteger> recipients, String reference)` Convenient function to send a simple message to a list of recipients
`VoiceMessageResponse`	`sendVoiceMessage(VoiceMessage voiceMessage)` Convenient function to send a simple message to a list of recipients
`Conversation`	`startConversation(ConversationStartRequest request)` Starts a conversation by sending an initial message.
`ChildAccountResponse`	`updateChildAccount(String name, String id)` Function to update a child account
`Contact`	`updateContact(String id, ContactRequest contactRequest)` Updates an existing contact.
`Conversation`	`updateConversation(String id, ConversationStatus status)` Updates a conversation.
`ConversationWebhook`	`updateConversationWebhook(String id, ConversationWebhookUpdateRequest request)` Update an existing webhook.
`Group`	`updateGroup(String id, GroupRequest groupRequest)` Updates an existing group.
`PurchasedNumber`	`updateNumber(String number, String... tags)` Updates tags on a particular existing Number.
`VoiceCallFlowResponse`	`updateVoiceCallFlow(String id, VoiceCallFlowRequest voiceCallFlowRequest)` Updates an existing Call Flow.
`WebhookResponseData`	`updateWebhook(String id, Webhook webhook)` Function to update a webhook
`TemplateResponse`	`updateWhatsAppTemplate(Template template, String templateName, String language)` Update a WhatsApp message template through MessageBird.
`FileUploadResponse`	`uploadFile(byte[] binary, String contentType, String filename)` Uploads a file and returns the assigned ID.
`Verify`	`verifyToken(String id, String token)`
`VoiceCallLeg`	`viewCallLegByCallIdAndLegId(String callId, String legId)` Retrieves a leg resource.
`VoiceCallLegResponse`	`viewCallLegsByCallId(String callId, Integer page, Integer pageSize)` Retrieves a listing of all legs.
`Contact`	`viewContact(String id)` Retrieves the information of an existing contact.
`Conversation`	`viewConversation(String id)` Gets a single conversation.
`ConversationMessage`	`viewConversationMessage(String messageId)` Gets a single message.
`ConversationWebhook`	`viewConversationWebhook(String webhookId)` Gets a single webhook.
`Group`	`viewGroup(String id)` Retrieves the information of an existing group.
`Lookup`	`viewLookup(BigInteger phoneNumber)` Send a Lookup request
`Lookup`	`viewLookup(Lookup lookup)` Send a Lookup request
`LookupHlr`	`viewLookupHlr(BigInteger phoneNumber)` View a Lookup HLR (lookup)
`LookupHlr`	`viewLookupHlr(LookupHlr lookupHlr)` View a Lookup HLR (lookup)
`MessageResponse`	`viewMessage(String id)` View a message from the Messagebird server
`PurchasedNumber`	`viewPurchasedNumber(String number)` Returns a Number that has already been purchased on the initialized account.
`RecordingResponse`	`viewRecording(String callID, String legId, String recordingId)` Function to view recording by call id , leg id and recording id
`TranscriptionResponse`	`viewTranscription(String callID, String legId, String recordingId, String transcriptionId)` Function to view recording by call id, leg id and recording id
`VoiceCallResponse`	`viewVoiceCall(String id)` Function to view voice call by id
`VoiceCallFlowResponse`	`viewVoiceCallFlow(String id)` Retrieves the information of an existing Call Flow.
`VoiceMessageResponse`	`viewVoiceMessage(String id)` View a message from the Messagebird server
`WebhookResponseData`	`viewWebhook(String id)` Function to view a webhook

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MessageBirdClient

public MessageBirdClient(MessageBirdService messageBirdService)

Method Detail

getBalance

public Balance getBalance()
                   throws GeneralException,
                          UnauthorizedException,
                          NotFoundException

MessageBird provides an API to get the balance information of your account.

Returns:: Balance object
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception; NotFoundException

getRequestHlr
```
public Hlr getRequestHlr(BigInteger msisdn,
                         String reference)
                  throws GeneralException,
                         UnauthorizedException
```
MessageBird provides an API to send Network Queries to any mobile number across the world. An HLR allows you to view which mobile number (MSISDN) belongs to what operator in real time and see whether the number is active.

Parameters:

msisdn - The telephone number.

reference - A client reference

Returns:

Hlr Object

Throws:

UnauthorizedException - if client is unauthorized

GeneralException - general exception

getViewHlr
```
public Hlr getViewHlr(String hlrId)
               throws GeneralException,
                      UnauthorizedException,
                      NotFoundException
```
Retrieves the information of an existing HLR. You only need to supply the unique message id that was returned upon creation or receiving.

Parameters:

hlrId - ID as returned by getRequestHlr in the id variable

Returns:

Hlr Object

Throws:

UnauthorizedException - if client is unauthorized

GeneralException - general exception

NotFoundException

sendMessage
```
public MessageResponse sendMessage(Message message)
                            throws UnauthorizedException,
                                   GeneralException
```
Send a message through the messagebird platform

Parameters:

message - Message object to be send

Returns:

Message Response

Throws:

UnauthorizedException - if client is unauthorized

GeneralException - general exception

sendMessage

public MessageResponse sendMessage(String originator,
                                   String body,
                                   List<BigInteger> recipients)
                            throws UnauthorizedException,
                                   GeneralException

Convenient function to send a simple message to a list of recipients

Parameters:: originator - Originator of the message, this will get truncated to 11 chars; body - Body of the message; recipients - List of recipients
Returns:: MessageResponse
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception

sendMessage

public MessageResponse sendMessage(String originator,
                                   String body,
                                   List<BigInteger> recipients,
                                   String reference)
                            throws UnauthorizedException,
                                   GeneralException

Convenient function to send a simple message to a list of recipients

Parameters:: originator - Originator of the message, this will get truncated to 11 chars; body - Body of the message; recipients - List of recipients; reference - your reference
Returns:: MessageResponse
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception

sendFlashMessage

public MessageResponse sendFlashMessage(String originator,
                                        String body,
                                        List<BigInteger> recipients)
                                 throws UnauthorizedException,
                                        GeneralException

Convenient function to send a simple flash message to a list of recipients

Parameters:: originator - Originator of the message, this will get truncated to 11 chars; body - Body of the message; recipients - List of recipients
Returns:: MessageResponse
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception

sendFlashMessage

public MessageResponse sendFlashMessage(String originator,
                                        String body,
                                        List<BigInteger> recipients,
                                        String reference)
                                 throws UnauthorizedException,
                                        GeneralException

Convenient function to send a simple flash message to a list of recipients

Parameters:: originator - Originator of the message, this will get truncated to 11 chars; body - Body of the message; recipients - List of recipients; reference - your reference
Returns:: MessageResponse
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception

listMessages

public MessageList listMessages(Integer offset,
                                Integer limit)
                         throws UnauthorizedException,
                                GeneralException

Throws:: UnauthorizedException; GeneralException

listMessagesFiltered

public MessageList listMessagesFiltered(Integer offset,
                                        Integer limit,
                                        Map<String,Object> filters)
                                 throws UnauthorizedException,
                                        GeneralException

Throws:: UnauthorizedException; GeneralException

deleteMessage
```
public void deleteMessage(String id)
                   throws UnauthorizedException,
                          GeneralException,
                          NotFoundException
```
Delete a message from the Messagebird server

Parameters:

id - A unique random ID which is created on the MessageBird platform

Throws:

UnauthorizedException - if client is unauthorized

GeneralException - general exception

NotFoundException

viewMessage

public MessageResponse viewMessage(String id)
                            throws UnauthorizedException,
                                   GeneralException,
                                   NotFoundException

View a message from the Messagebird server

Parameters:: id - A unique random ID which is created on the MessageBird platform
Returns:: MessageResponse
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception; NotFoundException

sendVoiceMessage

public VoiceMessageResponse sendVoiceMessage(VoiceMessage voiceMessage)
                                      throws UnauthorizedException,
                                             GeneralException

Convenient function to send a simple message to a list of recipients

Parameters:: voiceMessage - Voice message object
Returns:: VoiceMessageResponse
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception

sendVoiceMessage

public VoiceMessageResponse sendVoiceMessage(String body,
                                             List<BigInteger> recipients)
                                      throws UnauthorizedException,
                                             GeneralException

Convenient function to send a simple message to a list of recipients

Parameters:: body - Body of the message; recipients - List of recipients
Returns:: VoiceMessageResponse
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception

sendVoiceMessage

public VoiceMessageResponse sendVoiceMessage(String body,
                                             List<BigInteger> recipients,
                                             String reference)
                                      throws UnauthorizedException,
                                             GeneralException

Convenient function to send a simple message to a list of recipients

Parameters:: body - Body of the message; recipients - List of recipients; reference - your reference
Returns:: VoiceMessageResponse
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception

deleteVoiceMessage

public void deleteVoiceMessage(String id)
                        throws UnauthorizedException,
                               GeneralException,
                               NotFoundException

Delete a voice message from the Messagebird server

Parameters:: id - A unique random ID which is created on the MessageBird platform
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception; NotFoundException

viewVoiceMessage

public VoiceMessageResponse viewVoiceMessage(String id)
                                      throws UnauthorizedException,
                                             GeneralException,
                                             NotFoundException

View a message from the Messagebird server

Parameters:: id - A unique random ID which is created on the MessageBird platform
Returns:: VoiceMessageResponse
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception; NotFoundException

listVoiceMessages

public VoiceMessageList listVoiceMessages(Integer offset,
                                          Integer limit)
                                   throws UnauthorizedException,
                                          GeneralException

List voice messages

Parameters:: offset - offset for result list; limit - limit for result list
Returns:: VoiceMessageList
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception

sendVerifyToken
```
public Verify sendVerifyToken(VerifyRequest verifyRequest)
                       throws UnauthorizedException,
                              GeneralException
```
Parameters:

verifyRequest - includes recipient, originator, reference, type, datacoding, template, timeout, tokenLenght, voice, language

Returns:

Verify object

Throws:

UnauthorizedException - if client is unauthorized

GeneralException - general exception

sendVerifyToken
```
public Verify sendVerifyToken(String recipient)
                       throws UnauthorizedException,
                              GeneralException
```
Parameters:

recipient - The telephone number that you want to verify.

Returns:

Verify object

Throws:

UnauthorizedException - if client is unauthorized

GeneralException - general exception

verifyToken
```
public Verify verifyToken(String id,
                          String token)
                   throws NotFoundException,
                          GeneralException,
                          UnauthorizedException
```
Parameters:

id - A unique random ID which is created on the MessageBird platform

token - An unique token which was sent to the recipient upon creation of the object.

Returns:

Verify object

Throws:

NotFoundException - if id is not found

UnauthorizedException - if client is unauthorized

GeneralException - general exception

getVerifyObject

public Verify getVerifyObject(String id)
                       throws NotFoundException,
                              GeneralException,
                              UnauthorizedException

Parameters:: id - id is for getting verify object
Returns:: Verify object
Throws:: NotFoundException - if id is not found; UnauthorizedException - if client is unauthorized; GeneralException - general exception

getVerifyEmailMessage

public VerifyMessage getVerifyEmailMessage(String messageId)
                                    throws UnauthorizedException,
                                           GeneralException,
                                           NotFoundException

Parameters:: messageId - is for the email message part of a verify object
Returns:: Verify object
Throws:: NotFoundException - if id is not found; UnauthorizedException - if client is unauthorized; GeneralException - general exception

deleteVerifyObject

public void deleteVerifyObject(String id)
                        throws NotFoundException,
                               GeneralException,
                               UnauthorizedException

Parameters:: id - id for deleting verify object
Throws:: NotFoundException - if id is not found; UnauthorizedException - if client is unauthorized; GeneralException - general exception

viewLookup
```
public Lookup viewLookup(Lookup lookup)
                  throws UnauthorizedException,
                         GeneralException,
                         NotFoundException
```
Send a Lookup request

Parameters:

lookup - including with country code, country prefix, phone number, type, formats, country code

Returns:

Lookup

Throws:

UnauthorizedException - if client is unauthorized

GeneralException - general exception

NotFoundException - if lookup not found

viewLookup

public Lookup viewLookup(BigInteger phoneNumber)
                  throws UnauthorizedException,
                         GeneralException,
                         NotFoundException

Send a Lookup request

Parameters:: phoneNumber - phone number is for viewing lookup
Returns:: Lookup
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception; NotFoundException

requestLookupHlr
```
public LookupHlr requestLookupHlr(LookupHlr lookupHlr)
                           throws UnauthorizedException,
                                  GeneralException
```
Request a Lookup HLR (lookup)

Parameters:

lookupHlr - country code for request lookup hlr

Returns:

lookupHlr

Throws:

UnauthorizedException - if client is unauthorized

GeneralException - general exception

requestLookupHlr

public LookupHlr requestLookupHlr(BigInteger phoneNumber,
                                  String reference)
                           throws UnauthorizedException,
                                  GeneralException

Request a Lookup HLR (lookup)

Parameters:: phoneNumber - phone number is for request hlr; reference - reference for request hlr
Returns:: lookupHlr
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception

viewLookupHlr

public LookupHlr viewLookupHlr(LookupHlr lookupHlr)
                        throws UnauthorizedException,
                               GeneralException,
                               NotFoundException

View a Lookup HLR (lookup)

Parameters:: lookupHlr - search with country code
Returns:: LookupHlr
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception; NotFoundException - if there is no lookup hlr with given country code

viewLookupHlr

public LookupHlr viewLookupHlr(BigInteger phoneNumber)
                        throws UnauthorizedException,
                               GeneralException,
                               NotFoundException

View a Lookup HLR (lookup)

Parameters:: phoneNumber - phone number for searching on hlr
Returns:: LookupHlr
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception; NotFoundException - phone number not found on hlr

listVoiceCallFlows

public VoiceCallFlowList listVoiceCallFlows(Integer offset,
                                            Integer limit)
                                     throws UnauthorizedException,
                                            GeneralException

Convenient function to list all call flows

Parameters:: offset -; limit -
Returns:: VoiceCallFlowList
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception

viewVoiceCallFlow

public VoiceCallFlowResponse viewVoiceCallFlow(String id)
                                        throws NotFoundException,
                                               GeneralException,
                                               UnauthorizedException

Retrieves the information of an existing Call Flow. You only need to supply the unique call flow ID that was returned upon creation or receiving.

Parameters:: id - String
Returns:: VoiceCallFlowResponse
Throws:: NotFoundException; GeneralException; UnauthorizedException

sendVoiceCallFlow

public VoiceCallFlowResponse sendVoiceCallFlow(VoiceCallFlowRequest voiceCallFlowRequest)
                                        throws UnauthorizedException,
                                               GeneralException

Convenient function to create a call flow

Parameters:: voiceCallFlowRequest - VoiceCallFlowRequest
Returns:: VoiceCallFlowResponse
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception

updateVoiceCallFlow

public VoiceCallFlowResponse updateVoiceCallFlow(String id,
                                                 VoiceCallFlowRequest voiceCallFlowRequest)
                                          throws UnauthorizedException,
                                                 GeneralException

Updates an existing Call Flow. You only need to supply the unique id that was returned upon creation.

Parameters:: id - String; voiceCallFlowRequest - VoiceCallFlowRequest
Returns:: VoiceCallFlowResponse
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception

deleteVoiceCallFlow

public void deleteVoiceCallFlow(String id)
                         throws NotFoundException,
                                GeneralException,
                                UnauthorizedException

Convenient function to delete call flow

Parameters:: id - String
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception; NotFoundException

listContacts

public ContactList listContacts(int offset,
                                int limit)
                         throws UnauthorizedException,
                                GeneralException

Gets a contact listing with specified pagination options.

Returns:: Listing of Contact objects.
Throws:: UnauthorizedException; GeneralException

listContacts

public ContactList listContacts()
                         throws UnauthorizedException,
                                GeneralException

Gets a contact listing with default pagination options.

Throws:: UnauthorizedException; GeneralException

sendContact

public Contact sendContact(ContactRequest contactRequest)
                    throws UnauthorizedException,
                           GeneralException

Creates a new contact object. MessageBird returns the created contact object with each request.

Throws:: UnauthorizedException; GeneralException

updateContact

public Contact updateContact(String id,
                             ContactRequest contactRequest)
                      throws UnauthorizedException,
                             GeneralException

Updates an existing contact. You only need to supply the unique id that was returned upon creation.

Throws:: UnauthorizedException; GeneralException

viewContact

public Contact viewContact(String id)
                    throws NotFoundException,
                           GeneralException,
                           UnauthorizedException

Retrieves the information of an existing contact. You only need to supply the unique contact ID that was returned upon creation or receiving.

Throws:: NotFoundException; GeneralException; UnauthorizedException

deleteGroup

public void deleteGroup(String id)
                 throws NotFoundException,
                        GeneralException,
                        UnauthorizedException

Deletes an existing group. You only need to supply the unique id that was returned upon creation.

Throws:: NotFoundException; GeneralException; UnauthorizedException

deleteGroupContact

public void deleteGroupContact(String groupId,
                               String contactId)
                        throws NotFoundException,
                               GeneralException,
                               UnauthorizedException

Removes a contact from group. You need to supply the IDs of the group and contact. Does not delete the contact.

Throws:: NotFoundException; GeneralException; UnauthorizedException

listGroups

public GroupList listGroups(int offset,
                            int limit)
                     throws UnauthorizedException,
                            GeneralException

Gets a contact listing with specified pagination options.

Throws:: UnauthorizedException; GeneralException

listGroups

public GroupList listGroups()
                     throws UnauthorizedException,
                            GeneralException

Gets a contact listing with default pagination options.

Throws:: UnauthorizedException; GeneralException

sendGroup

public Group sendGroup(GroupRequest groupRequest)
                throws UnauthorizedException,
                       GeneralException

Creates a new group object. MessageBird returns the created group object with each request.

Throws:: UnauthorizedException; GeneralException

sendGroupContact

public void sendGroupContact(String groupId,
                             String[] contactIds)
                      throws NotFoundException,
                             GeneralException,
                             UnauthorizedException

Adds contact to group. You need to supply the IDs of the group and contact.

Throws:: NotFoundException; GeneralException; UnauthorizedException

updateGroup

public Group updateGroup(String id,
                         GroupRequest groupRequest)
                  throws UnauthorizedException,
                         GeneralException

Updates an existing group. You only need to supply the unique ID that was returned upon creation.

Throws:: UnauthorizedException; GeneralException

viewGroup

public Group viewGroup(String id)
                throws NotFoundException,
                       GeneralException,
                       UnauthorizedException

Retrieves the information of an existing group. You only need to supply the unique group ID that was returned upon creation or receiving.

Throws:: NotFoundException; GeneralException; UnauthorizedException

viewConversation

public Conversation viewConversation(String id)
                              throws NotFoundException,
                                     GeneralException,
                                     UnauthorizedException

Gets a single conversation.

Parameters:: id - Conversation to retrieved.
Returns:: The retrieved conversation.
Throws:: NotFoundException; GeneralException; UnauthorizedException

updateConversation

public Conversation updateConversation(String id,
                                       ConversationStatus status)
                                throws UnauthorizedException,
                                       GeneralException

Updates a conversation.

Parameters:: id - Conversation to update.; status - New status for the conversation.
Returns:: The updated Conversation.
Throws:: UnauthorizedException; GeneralException

listConversations

public ConversationList listConversations(int offset,
                                          int limit)
                                   throws UnauthorizedException,
                                          GeneralException

Gets a Conversation listing with specified pagination options.

Parameters:: offset - Number of objects to skip.; limit - Number of objects to take.
Returns:: List of conversations.
Throws:: UnauthorizedException; GeneralException

listConversations

public ConversationList listConversations()
                                   throws UnauthorizedException,
                                          GeneralException

Gets a contact listing with default pagination options.

Returns:: List of conversations.
Throws:: UnauthorizedException; GeneralException

startConversation

public Conversation startConversation(ConversationStartRequest request)
                               throws UnauthorizedException,
                                      GeneralException

Starts a conversation by sending an initial message.

Parameters:: request - Data for this request.
Returns:: The created Conversation.
Throws:: UnauthorizedException; GeneralException

sendMessage
```
public ConversationSendResponse sendMessage(ConversationSendRequest request)
                                     throws UnauthorizedException,
                                            GeneralException
```
sendMessage allows you to send message to users over any communication platform supported by Programmable Conversations

Parameters:

request - Data for this request.

Returns:

The created Message in ConversationSendResponse object.

Throws:

UnauthorizedException

GeneralException

listConversationMessages

public ConversationMessageList listConversationMessages(String conversationId,
                                                        int offset,
                                                        int limit)
                                                 throws UnauthorizedException,
                                                        GeneralException

Gets a ConversationMessage listing with specified pagination options.

Parameters:: conversationId - Conversation to get messages for.; offset - Number of objects to skip.; limit - Number of objects to take.
Returns:: List of messages.
Throws:: UnauthorizedException; GeneralException

listConversationMessages

public ConversationMessageList listConversationMessages(String conversationId)
                                                 throws UnauthorizedException,
                                                        GeneralException

Gets a ConversationMessage listing with default pagination options.

Parameters:: conversationId - Conversation to get messages for.
Returns:: List of messages.
Throws:: UnauthorizedException; GeneralException

viewConversationMessage

public ConversationMessage viewConversationMessage(String messageId)
                                            throws NotFoundException,
                                                   GeneralException,
                                                   UnauthorizedException

Gets a single message.

Parameters:: messageId - Message to retrieve.
Returns:: The retrieved message.
Throws:: NotFoundException; GeneralException; UnauthorizedException

listConversationMessagesWithQueryParam

public ConversationMessageList listConversationMessagesWithQueryParam(Map<String,Object> queryParams)
                                                               throws NotFoundException,
                                                                      GeneralException,
                                                                      UnauthorizedException

Gets conversation messages based on query param.

Parameters:: queryParams - only `ids` and `from` is available as an option
Returns:: The retrieved messages.
Throws:: NotFoundException; GeneralException; UnauthorizedException

sendConversationMessage

public ConversationMessage sendConversationMessage(String conversationId,
                                                   ConversationMessageRequest request)
                                            throws UnauthorizedException,
                                                   GeneralException

Sends a message to an existing Conversation.

Parameters:: conversationId - Conversation to send message to.; request - Message to send.
Returns:: The newly created message.
Throws:: UnauthorizedException; GeneralException

deleteConversationWebhook

public void deleteConversationWebhook(String webhookId)
                               throws NotFoundException,
                                      GeneralException,
                                      UnauthorizedException

Deletes a webhook.

Parameters:: webhookId - Webhook to delete.
Throws:: NotFoundException; GeneralException; UnauthorizedException

sendConversationWebhook

public ConversationWebhook sendConversationWebhook(ConversationWebhookCreateRequest request)
                                            throws UnauthorizedException,
                                                   GeneralException

Creates a new webhook.

Parameters:: request - Webhook to create.
Returns:: Newly created webhook.
Throws:: UnauthorizedException; GeneralException

updateConversationWebhook

public ConversationWebhook updateConversationWebhook(String id,
                                                     ConversationWebhookUpdateRequest request)
                                              throws UnauthorizedException,
                                                     GeneralException

Update an existing webhook.

Parameters:: request - update request.
Returns:: Updated webhook.
Throws:: UnauthorizedException; GeneralException

viewConversationWebhook

public ConversationWebhook viewConversationWebhook(String webhookId)
                                            throws NotFoundException,
                                                   GeneralException,
                                                   UnauthorizedException

Gets a single webhook.

Parameters:: webhookId - Webhook to retrieve.
Returns:: The retrieved webhook.
Throws:: NotFoundException; GeneralException; UnauthorizedException

listConversationWebhooks

public ConversationWebhookList listConversationWebhooks(int offset,
                                                        int limit)
                                                 throws UnauthorizedException,
                                                        GeneralException

Gets a ConversationWebhook listing with the specified pagination options.

Parameters:: offset - Number of objects to skip.; limit - Number of objects to skip.
Returns:: List of webhooks.
Throws:: UnauthorizedException; GeneralException

listConversationWebhooks

public ConversationWebhookList listConversationWebhooks()
                                                 throws UnauthorizedException,
                                                        GeneralException

Gets a ConversationWebhook listing with default pagination options.

Returns:: List of webhooks.
Throws:: UnauthorizedException; GeneralException

sendVoiceCall

public VoiceCallResponse sendVoiceCall(VoiceCall voiceCall)
                                throws UnauthorizedException,
                                       GeneralException

Function for voice call to a number

Parameters:: voiceCall - Voice call object
Returns:: VoiceCallResponse
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception

listAllVoiceCalls

public VoiceCallResponseList listAllVoiceCalls(Integer page,
                                               Integer pageSize)
                                        throws GeneralException,
                                               UnauthorizedException

Function to list all voice calls

Returns:: VoiceCallResponseList
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception

viewVoiceCall

public VoiceCallResponse viewVoiceCall(String id)
                                throws NotFoundException,
                                       GeneralException,
                                       UnauthorizedException

Function to view voice call by id

Parameters:: id - Voice call ID
Returns:: VoiceCallResponse
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception; NotFoundException

deleteVoiceCall

public void deleteVoiceCall(String id)
                     throws NotFoundException,
                            GeneralException,
                            UnauthorizedException

Function to delete voice call by id

Parameters:: id - Voice call ID
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception; NotFoundException

viewCallLegsByCallId

public VoiceCallLegResponse viewCallLegsByCallId(String callId,
                                                 Integer page,
                                                 Integer pageSize)
                                          throws UnsupportedEncodingException,
                                                 UnauthorizedException,
                                                 GeneralException

Retrieves a listing of all legs.

Parameters:: callId - Voice call ID; page - page to fetch (can be null - will return first page), number of first page is 1; pageSize - page size
Returns:: VoiceCallLegResponse
Throws:: UnsupportedEncodingException - no UTF8 supported url; UnauthorizedException - if client is unauthorized; GeneralException - general exception

viewCallLegByCallIdAndLegId

public VoiceCallLeg viewCallLegByCallIdAndLegId(String callId,
                                                String legId)
                                         throws UnsupportedEncodingException,
                                                NotFoundException,
                                                GeneralException,
                                                UnauthorizedException

Retrieves a leg resource. The parameters are the unique ID of the call and of the leg that were returned upon their respective creation.

Parameters:: callId - Voice call ID; legId - ID of leg of specified call {callId}
Returns:: VoiceCallLeg
Throws:: UnsupportedEncodingException - no UTF8 supported url; NotFoundException - not found with callId and legId; UnauthorizedException - if client is unauthorized; GeneralException - general exception

viewRecording

public RecordingResponse viewRecording(String callID,
                                       String legId,
                                       String recordingId)
                                throws NotFoundException,
                                       GeneralException,
                                       UnauthorizedException

Function to view recording by call id , leg id and recording id

Parameters:: callID - Voice call ID; legId - Leg ID; recordingId - Recording ID
Returns:: Recording
Throws:: NotFoundException - not found with callId and legId; UnauthorizedException - if client is unauthorized; GeneralException - general exception

downloadRecording
```
public String downloadRecording(String callID,
                                String legId,
                                String recordingId,
                                String basePath)
                         throws NotFoundException,
                                GeneralException,
                                UnauthorizedException
```
Downloads the record in .wav format by using callId, legId and recordId and stores to basePath. basePath is not mandatory to set. If basePath is not set, default download will be the /Download folder in user group.

Parameters:

callID - Voice call ID

legId - Leg ID

recordingId - Recording ID

basePath - store location. It should be directory. Property is Optional if $HOME is accessible

Returns:

the path that file is stored

Throws:

NotFoundException - if the recording does not found

GeneralException - general exception

UnauthorizedException - if client is unauthorized

listRecordings

public RecordingResponse listRecordings(String callID,
                                        String legId,
                                        Integer offset,
                                        Integer limit)
                                 throws GeneralException,
                                        UnauthorizedException

List the all recordings related to CallID and LegId

Parameters:: callID - Voice call ID; legId - Leg ID; offset - Number of objects to skip.; limit - Number of objects to take.
Returns:: Recordings for CallID and LegID
Throws:: GeneralException - if client is unauthorized; UnauthorizedException - general exception

deleteRecording

public void deleteRecording(String callID,
                            String legID,
                            String recordingID)
                     throws NotFoundException,
                            GeneralException,
                            UnauthorizedException

Deletes a voice recording

Parameters:: callID - Voice call ID; legID - Leg ID; recordingID - Recording ID
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception; NotFoundException

createTranscription

public TranscriptionResponse createTranscription(String callID,
                                                 String legId,
                                                 String recordingId,
                                                 String language)
                                          throws UnauthorizedException,
                                                 GeneralException

Function to view recording by call id , leg id and recording id

Parameters:: callID - Voice call ID; legId - Leg ID; recordingId - Recording ID; language - Language
Returns:: TranscriptionResponseList
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception

viewTranscription

public TranscriptionResponse viewTranscription(String callID,
                                               String legId,
                                               String recordingId,
                                               String transcriptionId)
                                        throws UnauthorizedException,
                                               GeneralException,
                                               NotFoundException

Function to view recording by call id, leg id and recording id

Parameters:: callID - Voice call ID; legId - Leg ID; recordingId - Recording ID; transcriptionId - Transcription ID
Returns:: Transcription
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception; NotFoundException - If transcription is not found

listTranscriptions

public TranscriptionResponse listTranscriptions(String callID,
                                                String legId,
                                                String recordingId,
                                                Integer page,
                                                Integer pageSize)
                                         throws UnauthorizedException,
                                                GeneralException

Lists the Transcription of callId, legId and recordId

Parameters:: callID - Voice call ID; legId - Leg ID; recordingId - Recording ID; page - page to fetch (can be null - will return first page), number of first page is 1; pageSize - page size
Returns:: List of Transcription
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception

downloadTranscription

public String downloadTranscription(String callID,
                                    String legId,
                                    String recordingId,
                                    String transcriptionId,
                                    String basePath)
                             throws UnauthorizedException,
                                    GeneralException,
                                    NotFoundException

Downloads the transcription in .txt format by using callId, legId, recordId and transcriptionId and stores to basePath. basePath is not mandatory to set. If basePath is not set, default download will be the /Download folder in user group.

Parameters:: callID - Voice call ID; legId - Leg ID; recordingId - Recording ID; transcriptionId - Transcription ID; basePath - store location. It should be directory. Property is Optional if $HOME is accessible
Returns:: the path that file is stored
Throws:: NotFoundException - if the recording does not found; GeneralException - general exception; UnauthorizedException - if client is unauthorized

createWebhook

public WebhookResponseData createWebhook(Webhook webhook)
                                  throws UnauthorizedException,
                                         GeneralException

Function to create a webhook

Parameters:: webhook - webhook to create
Returns:: WebhookResponseData created webhook
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception

updateWebhook

public WebhookResponseData updateWebhook(String id,
                                         Webhook webhook)
                                  throws UnauthorizedException,
                                         GeneralException

Function to update a webhook

Parameters:: webhook - webhook fields to update
Returns:: WebhookResponseData updated webhook
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception

viewWebhook

public WebhookResponseData viewWebhook(String id)
                                throws NotFoundException,
                                       GeneralException,
                                       UnauthorizedException

Function to view a webhook

Parameters:: id - id of a webhook
Returns:: WebhookResponseData
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception; NotFoundException

listWebhooks

public WebhookList listWebhooks(Integer offset,
                                Integer limit)
                         throws UnauthorizedException,
                                GeneralException

Function to list webhooks

Parameters:: offset - offset for result list; limit - limit for result list
Returns:: WebhookList
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception

deleteWebhook
```
public void deleteWebhook(String id)
                   throws NotFoundException,
                          GeneralException,
                          UnauthorizedException
```
Function to delete a webhook

Parameters:

id - A unique random ID which is created on the MessageBird platform

Throws:

NotFoundException - if id is not found

GeneralException - general exception

UnauthorizedException - if client is unauthorized

listNumbersForPurchase

public PhoneNumbersResponse listNumbersForPurchase(String countryCode)
                                            throws GeneralException,
                                                   UnauthorizedException,
                                                   NotFoundException,
                                                   IllegalArgumentException

Lists Numbers that are available to purchase in a particular country code, without any filters.

Parameters:: countryCode - The country code in which the Number should be purchased.
Throws:: GeneralException - general exception; UnauthorizedException - if client is unauthorized; NotFoundException - if the resource is missing; IllegalArgumentException - if the country code provided is invalid

listNumbersForPurchase

public PhoneNumbersResponse listNumbersForPurchase(String countryCode,
                                                   PhoneNumbersLookup params)
                                            throws GeneralException,
                                                   UnauthorizedException,
                                                   NotFoundException,
                                                   IllegalArgumentException

Lists Numbers that are available to purchase in a particular country code, according to specified search criteria.

Parameters:: countryCode - The country code in which the Number should be purchased.; params - Parameters to filter the resulting phone numbers returned.
Throws:: GeneralException - general exception; UnauthorizedException - if client is unauthorized; NotFoundException - if the resource is missing; IllegalArgumentException - if the country code provided is invalid

purchaseNumber

public PurchasedNumberCreatedResponse purchaseNumber(String number,
                                                     String countryCode,
                                                     int billingIntervalMonths)
                                              throws UnauthorizedException,
                                                     GeneralException,
                                                     IllegalArgumentException

Purchases a phone number. To be used in conjunction with listNumbersForPurchase to identify available numbers.

Parameters:: number - The number to purchase.; countryCode - The country code in which the Number should be purchased.
Throws:: GeneralException - general exception; UnauthorizedException - if client is unauthorized; IllegalArgumentException - if the country code provided is invalid

listPurchasedNumbers

public PurchasedNumbersResponse listPurchasedNumbers(PurchasedNumbersFilter filter)
                                              throws UnauthorizedException,
                                                     GeneralException,
                                                     NotFoundException

Lists Numbers that were purchased using the account credentials that the client was initialized with.

Parameters:: filter - Filters the list of purchased numbers according to search criteria.
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception; NotFoundException - if the resource is missing

viewPurchasedNumber

public PurchasedNumber viewPurchasedNumber(String number)
                                    throws UnauthorizedException,
                                           GeneralException,
                                           NotFoundException

Returns a Number that has already been purchased on the initialized account.

Parameters:: number - The number whose data should be returned.
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception; NotFoundException - if the Number is missing

updateNumber
```
public PurchasedNumber updateNumber(String number,
                                    String... tags)
                             throws UnauthorizedException,
                                    GeneralException
```
Updates tags on a particular existing Number. Any number of parameters after the number can be given to apply multiple tags.

Parameters:

number - The number to update.

tags - A tag to apply to the number.

Throws:

UnauthorizedException - if client is unauthorized

GeneralException - general exception

cancelNumber

public void cancelNumber(String number)
                  throws UnauthorizedException,
                         GeneralException,
                         NotFoundException

Cancels a particular number.

Parameters:: number - The number to cancel.
Throws:: GeneralException - general exception; UnauthorizedException - if client is unauthorized; NotFoundException - if the resource is missing

uploadFile
```
public FileUploadResponse uploadFile(byte[] binary,
                                     String contentType,
                                     String filename)
                              throws GeneralException,
                                     UnauthorizedException
```
Uploads a file and returns the assigned ID.

Parameters:

binary - the bytes of the file to upload.

contentType - the content type of the file (e.g. "image/png").

filename - optional filename to set in the upload request headers.

Returns:

FileUploadResponse

Throws:

GeneralException - general exception

UnauthorizedException - if client is unauthorized

See Also:

downloadFile(java.lang.String, java.lang.String, java.lang.String)

downloadFile
```
public String downloadFile(String id,
                           String filename,
                           String basePath)
                    throws GeneralException,
                           UnauthorizedException,
                           NotFoundException
```
Downloads a file and stores it with the provided filename in the basePath directory. The basePath may be null. If basePath is null, the default download directory will be the /Download folder in the user home directory. The filename may be null. If filename is null, the provided id will be used as the filename instead.

Parameters:

id - the ID of the file, provided when the file was uploaded

basePath - store location. It should be a directory. Property is nullable if $HOME is accessible

filename - the name of the file to download to.

Returns:

the path where the downloaded file is stored

Throws:

NotFoundException - if the file does not exist

GeneralException - general exception

UnauthorizedException - if client is unauthorized

See Also:

uploadFile(byte[], java.lang.String, java.lang.String)

createWhatsAppTemplate

public TemplateResponse createWhatsAppTemplate(Template template)
                                        throws UnauthorizedException,
                                               GeneralException,
                                               IllegalArgumentException

Create a WhatsApp message template through messagebird.

Parameters:: template - Template object to be created
Returns:: TemplateResponse response object
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception; IllegalArgumentException - invalid template format

updateWhatsAppTemplate

public TemplateResponse updateWhatsAppTemplate(Template template,
                                               String templateName,
                                               String language)
                                        throws UnauthorizedException,
                                               GeneralException,
                                               IllegalArgumentException

Update a WhatsApp message template through MessageBird.

Parameters:: template - Template object to be created; templateName - A name as returned by getWhatsAppTemplateBy in the name variable; language - A language code as returned by getWhatsAppTemplateBy in the language variable
Returns:: TemplateResponse response object
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception; IllegalArgumentException - invalid template format

listWhatsAppTemplates

public TemplateList listWhatsAppTemplates(int offset,
                                          int limit)
                                   throws UnauthorizedException,
                                          GeneralException

Gets a WhatsAppTemplate listing with specified pagination options.

Parameters:: offset - Number of objects to skip.; limit - Number of objects to take.
Returns:: List of templates.
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception

listWhatsAppTemplates

public TemplateList listWhatsAppTemplates(int offset,
                                          int limit,
                                          String wabaID,
                                          String channelID)
                                   throws UnauthorizedException,
                                          GeneralException,
                                          IllegalArgumentException

Gets a WhatsAppTemplate listing with specified pagination options and a wabaID or channelID filter.

Parameters:: offset - Number of objects to skip.; limit - Number of objects to take.; wabaID - The WABA ID to filter templates by.; channelID - A channel ID filter to return only templates that can be sent via that channel.
Returns:: List of templates.
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception; IllegalArgumentException - if the provided arguments are not valid

listWhatsAppTemplates

public TemplateList listWhatsAppTemplates()
                                   throws UnauthorizedException,
                                          GeneralException

Gets a template listing with default pagination options.

Returns:: List of whatsapp templates.
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception

getWhatsAppTemplatesBy

public List<TemplateResponse> getWhatsAppTemplatesBy(String templateName)
                                              throws GeneralException,
                                                     UnauthorizedException,
                                                     NotFoundException,
                                                     IllegalArgumentException

Retrieves the template of an existing template name.

Parameters:: templateName - A name as returned by getWhatsAppTemplateBy in the name variable
Returns:: List<TemplateResponse> template list
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception; NotFoundException - if template name is not found; IllegalArgumentException - if the provided arguments are not valid

getWhatsAppTemplatesBy

public List<TemplateResponse> getWhatsAppTemplatesBy(String templateName,
                                                     String wabaID,
                                                     String channelID)
                                              throws GeneralException,
                                                     UnauthorizedException,
                                                     NotFoundException,
                                                     IllegalArgumentException

Retrieves the template of an existing template name.

Parameters:: templateName - A name as returned by getWhatsAppTemplateBy in the name variable; wabaID - An optional WABA ID to look for the template ID under.; channelID - An optional channel ID to specify. If the template can be sent via the channel, it will return the template.
Returns:: List<TemplateResponse> template list
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception; NotFoundException - if template name is not found under the given WABA or cannot be sent under the supplied channel ID; IllegalArgumentException - if the provided arguments are not valid

fetchWhatsAppTemplateBy
```
public TemplateResponse fetchWhatsAppTemplateBy(String templateName,
                                                String language)
                                         throws GeneralException,
                                                UnauthorizedException,
                                                NotFoundException,
                                                IllegalArgumentException
```
Retrieves the template of an existing template name and language under the first waba connected to the requesting user.

Parameters:

templateName - A name as returned by getWhatsAppTemplateBy in the name variable

language - A language code as returned by getWhatsAppTemplateBy in the language variable

Returns:

TemplateResponse template

Throws:

UnauthorizedException - if client is unauthorized

GeneralException - general exception

NotFoundException - if template name and language are not found under the first waba connected to the requesting user.

IllegalArgumentException - if the provided arguments are not valid

fetchWhatsAppTemplateBy

public TemplateResponse fetchWhatsAppTemplateBy(String templateName,
                                                String language,
                                                String wabaID,
                                                String channelID)
                                         throws GeneralException,
                                                UnauthorizedException,
                                                NotFoundException,
                                                IllegalArgumentException

Retrieves the template of an existing template name and language under a WABA or for a channel.

Parameters:: templateName - A name as returned by getWhatsAppTemplateBy in the name variable; language - A language code as returned by getWhatsAppTemplateBy in the language variable; wabaID - An optional WABA ID to look for the template ID under.; channelID - An optional channel ID to specify. If the template can be sent via the channel, it will return the template.
Returns:: TemplateResponse template
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception; NotFoundException - if template name and language are not found under the given WABA or cannot be sent under the supplied channel ID.; IllegalArgumentException - if the provided arguments are not valid

deleteTemplatesBy
```
public void deleteTemplatesBy(String templateName)
                       throws UnauthorizedException,
                              GeneralException,
                              NotFoundException
```
Delete templates of an existing template name.

Parameters:

templateName - A template name which is created on the MessageBird platform

Throws:

UnauthorizedException - if client is unauthorized

GeneralException - general exception

NotFoundException - if template name is not found

createChildAccount

public ChildAccountCreateResponse createChildAccount(ChildAccountRequest childAccountRequest)
                                              throws UnauthorizedException,
                                                     GeneralException

Function to create a child account

Parameters:: childAccountRequest - of child account to create
Returns:: ChildAccountResponse created
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception

updateChildAccount

public ChildAccountResponse updateChildAccount(String name,
                                               String id)
                                        throws UnauthorizedException,
                                               GeneralException

Function to update a child account

Parameters:: id - of child account to update
Returns:: ChildAccountResponse created
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception

getChildAccountById

public ChildAccountDetailedResponse getChildAccountById(String id)
                                                 throws UnauthorizedException,
                                                        GeneralException,
                                                        NotFoundException

Function to get a child account

Parameters:: id - of child account to update
Returns:: ChildAccountResponse created
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception; NotFoundException - if id is not found

getChildAccounts

public List<ChildAccountResponse> getChildAccounts(Integer offset,
                                                   Integer limit)
                                            throws UnauthorizedException,
                                                   GeneralException

Function to get a child account

Returns:: ChildAccountResponse created
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception

deleteChildAccount

public void deleteChildAccount(String id)
                        throws UnauthorizedException,
                               GeneralException,
                               NotFoundException

Function to delete a child account

Parameters:: id - of child account to delete
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception; NotFoundException - if id is not found

getOutboundSmsPrices

public OutboundSmsPriceResponse getOutboundSmsPrices()
                                              throws GeneralException,
                                                     UnauthorizedException,
                                                     NotFoundException

Returns outbound pricing for the default SMS configuration for the authenticated account.

Returns:: outbound pricing for the default SMS configuration for the authenticated account
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception; NotFoundException - if pricing information could not be found
See Also:: Pricing API

getOutboundSmsPrices

public OutboundSmsPriceResponse getOutboundSmsPrices(String smppUsername)
                                              throws GeneralException,
                                                     UnauthorizedException,
                                                     NotFoundException

Returns outbound SMS pricing for a specific SMPP username.

Parameters:: smppUsername - the SMPP SystemID provided by MessageBird
Returns:: outbound SMS pricing for the given SMPP username
Throws:: UnauthorizedException - if client is unauthorized; GeneralException - general exception; NotFoundException - if pricing information could not be found for the given SMPP username
See Also:: Pricing API

Class MessageBirdClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MessageBirdClient

Method Detail

getBalance

getRequestHlr

getViewHlr

sendMessage

sendMessage

sendMessage

sendFlashMessage

sendFlashMessage

listMessages

listMessagesFiltered

deleteMessage

viewMessage

sendVoiceMessage

sendVoiceMessage

sendVoiceMessage

deleteVoiceMessage

viewVoiceMessage

listVoiceMessages

sendVerifyToken

sendVerifyToken

verifyToken

getVerifyObject

getVerifyEmailMessage

deleteVerifyObject

viewLookup

viewLookup

requestLookupHlr

requestLookupHlr

viewLookupHlr

viewLookupHlr

listVoiceCallFlows

viewVoiceCallFlow

sendVoiceCallFlow

updateVoiceCallFlow

deleteVoiceCallFlow

listContacts

listContacts

sendContact

updateContact

viewContact

deleteGroup

deleteGroupContact

listGroups

listGroups

sendGroup

sendGroupContact

updateGroup

viewGroup

viewConversation

updateConversation

listConversations

listConversations

startConversation

sendMessage

listConversationMessages

listConversationMessages

viewConversationMessage

listConversationMessagesWithQueryParam

sendConversationMessage

deleteConversationWebhook

sendConversationWebhook

updateConversationWebhook

viewConversationWebhook

listConversationWebhooks

listConversationWebhooks

sendVoiceCall

listAllVoiceCalls

viewVoiceCall

deleteVoiceCall

viewCallLegsByCallId

viewCallLegByCallIdAndLegId

viewRecording

downloadRecording