Quickstarts Api Reference Tutorials

API Reference

Introduction SDKs API Endpoint Authentication IP Addresses API Access Key Security API Errors Requests HTTP Methods Verifying Requests

Request signing Regenerate Signature Details Usage

Overview API Endpoint HTTP methods Rate Limiting Object Send SMS Handle SMS status Receive SMS View List messsages List scheduled SMS Statuses

Hierarchy Error Codes

SMPP servers Supported PDUs

SMS batch API Voice Calling

Overview Requests/responses Call flows Dynamic call flows Call flow steps Calls Legs Recordings Transcriptions Numbers Webhooks Callbacks

Voice Messaging

Overview Object Body Send View List messages Handle status

Conversations APIContacts API (v2)

Endpoints Summary The Contact object The Identifier object The Profile Object List all Contacts Create a Contact View a Contact Update a Contact Update or Create Contact Delete a Contact Merge contacts List all identifiers of a contact Get a specific identifier of a contact Add an Identifier to an existing Contact Delete an identifier from a contact Import Contacts Track an Imported File

Integrations API

Create template Update template List templates List templates by name Fetch template by name and language Delete templates by name Delete template by name and language

Objects reference

File Storage API

Upload file Fetch file Delete file

Omnichannel Widget Numbers

Overview Authorization Formats and Headers Errors Searching Purchasing Fetch all numbers Fetch a number Update Search available for back order products Fetching back order product details Place a back order Fetching a placed back order Fetching back order KYC documents requirements Uploading back order KYC documents Fetching back order EUD requirements Uploading back order EUD information Cancel Number pools

Partner Accounts

Overview Child Accounts Formats and Headers Errors Create a Child Account Edit a Child Account Fetch a Child Account Delete Child Account

Overview Object Request Verify token View Delete

Overview Object View Send Receive Handle status Media attachments

Overview Object Request View Handle response

Overview Object Get your balance

Overview Object Request Lookup Request HLR View Handle response

Overview Object Create View Update Delete

Overview Object Create View Update Add contact Remove contact Delete

Base URL Authorization ListDatasets GetDataset PredictIntent ListSupportedLanguages Objects Reference

Dataset Language LanguageCode LanguageList ListDatasetMode ListDatasetsResponse PredictIntentResponse

Base URL Authorization ListDatasets GetDataset PredictAnswer ListSupportedLanguages Objects Reference

Answer Dataset Language LanguageCode LanguageList ListDatasetsMode ListDatasetsResponse PredictAnswerResponse

Named Entity RecognitionLanguage Detection

Base URL Authorization PredictLanguage ListSupportedLanguages Objects Reference

Language LanguageCode LanguageList PredictLanguageRequest PredictLanguageResponse

Balance API

MessageBird's Balance API allows you to retrieve your total balance and balance information from your account, such as currency and type of payment (prepaid, postpaid).

You can use the Balance API to expose this information in one of your app or internal dashboards, as well as to send notifications.

The Balance API uses HTTP verbs and a RESTful endpoint structure with an access key that is used as the API Authorization framework. Request and response payloads are formatted as JSON—although we provide a GET alternative for requests—using UTF-8 encoding and URL encoded values.

API Endpoint

All URLs referenced in MessageBird's Balance Messaging API documentation have the base URL in the code snippet on the right side:

API Endpoint

https://rest.messagebird.com/balance

Available HTTP methods

The MessageBird API uses HTTP verbs to understand if you want to read (GET), delete (DELETE) or create (POST) an object. When your web application cannot do a POST or DELETE, we provide the ability to set the method through the query parameter _method.

Available HTTP methods

GET /balance

The balance object

This object represents your balance at MessageBird.com

Attributes

Attribute	Type	Description
payment	string	Your payment method. Possible values are: prepaid & postpaid
type	string	Your payment type. Possible values are: credits, euros, pounds & dollars. For all other supported currencies, an ISO-4217 code is returned.
amount	float	The amount of balance of the payment type. When postpaid is your payment method, the amount will be 0.

Balance object example

{
  "payment": "prepaid",
  "type": "euros",
  "amount": 103
}

Get your balance

Retrieves your MessageBird balance.

Example request

curl -X GET https://rest.messagebird.com/balance \
  -H 'Authorization: AccessKey test_gshuPaZoeEG6ovbc8M79w0QyM'

Returns

Returns a balance object if the request was successful. If the request failed, an error object will be returned.

Blance object example

{
  "payment": "prepaid",
  "type": "euros",
  "amount": 103
}

Is this page useful?

Next upLookup

Questions?

We’re always happy to help with code or other doubts you might have! Check out our Quickstarts, API Reference, Tutorials, SDKs, or contact our Support team.

Cookie Settings