Getting Started with theManagement APIs
’s Management APIs provide all the tools you need to monitor and manage your accounts, applications, phone numbers, notifications and usage statistics.
The Management APIs are implemented on the top of the HTTP protocol and can be used with a programming language of choice.
Management APIs support the following capabilities:
HTTPS and basic authentication
HTTP GET, POST, PUT and DELETE requests
XML or JSON responses
GET: Lists or reads objects and includes the information needed to perform any Read operations on the object. Sample use: list all of the applications under youraccount.
POST/PUT: Creates or updates objects. Most requests using the POST/PUT method require JSON/XML in the request body. Sample use: modify a Client under youraccount.
DELETE: Removes objects. Sample use: delete an application or client under youraccount.
Management APIs use basic HTTP authentication to restrict access to API endpoints to authenticated users only. After you sign up with , you can find your Account SID and Auth Token by navigating to Your Profile → Account in the Console.
You then need to use these credentials in your request’s Authorization header using Basic authentication type (i.e. Authorization: Basic <base64-encoded AccountSID:AuthToken>). Here’s how you would use an HTTP client to authenticate with:
curl -X GET https://mycompany.restcomm.com/restcomm/2012-04-24/Accounts/ACCOUNT_SID.json?PageSize=1 \ -u 'YourAccountSid:YourAuthToken'
API resources are accessed via HTTPS requests utilizing UTF-8 format. Data passed to the API through POST and PUT requests should use urlencoded format (i.e. Content-Type: application/x-www-form-urlencoded).
can return its API responses either in .json or .xml format depending on the suffix of the URL the request was made on. For example, a request sent to
will yield a .json response, while a request sent to
will yield an .xml response.
Some Management APIs support pagination by accepting as query parameters the page number we interested in as well as the page size. The following query parameters are supported:
Which page of SMS records to return, starting from 0.
Number of records returned per page.
For example, the following request will return the first page of results with a size of 10 items:
curl -X GET https://mycompany.restcomm.com/restcomm/2012-04-24/Accounts/ACCOUNT_SID/SMS/Messages.json?Page=0&PageSize=10 \ -u 'YourAccountSid:YourAuthToken'