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