Getting started with the SSG Management API
Management API v2A REST v2 is available on staging. See Getting started (v2). The v1 API below is unchanged.
API keys for using the SSG Management API can be created in the Configuration > Company > User access section of the SSG Administration Portal. The management API key (key) must be included in the URL query parameters.
The SSG Management API enables you to:
- Query the status of messages submitted to the SSG
- Manage customers accounts
- Manage suppliers SMSC/SMS gateways
Customer sign-ups
Sign-ups from customers can be posted into your SSG using the Public Signup API. These will appear in the Customers > Sign-ups section of your SSG where you can then provide service or reject the sign-up.
Limits
Each SSG should not exceed the following Management API limits:
- 5 API calls/second
- 200 API calls/minute
- 8000 API calls/hour
Publish service pricing
The Publish pricing API can be used to retrieve current and future pricing for a pricing plan from your SSG. This can be used to populate a coverage and pricing page on your website, or used in an external application.
txtConsole SMS APIFor the txtConsole REST API for sending/receiving SMS, go to the following documentation: