Messaging Application Admin API¶
Overview¶
Some of the messaging-related settings of your application — the ones you would normally manage in the Cloud Softphone portal — can also be managed programmatically through the Messaging Application Admin API.
Getting access¶
The Messaging Application Admin API is not enabled by default. To start using it:
- Contact Acrobits support and request access to the Messaging Application Admin API for your application.
- Support will issue an API key for your application.
- Store the API key securely — it grants full access to your application's Admin API and must be treated as a secret.
Authentication¶
Each API key is bound to one application, identified by its cloudId. The
cloudId is part of every endpoint URL and determines which application a
request operates on; an API key is only valid for its own cloudId.
All requests must be authenticated with the API key, sent in an HTTP header:
Requests without a valid key for the cloudId in the URL are rejected with
401 Unauthorized.
API base URL¶
All Messaging Application Admin API endpoints share a common host and base path that includes your cloudId. They are served over HTTPS from:
Available APIs¶
| API | Description |
|---|---|
| 10DLC Application Admin API | Manage the 10DLC settings (brand, contact info, custom welcome/opt-out/opt-in/help texts) for your application. |