Siptalk API Overview
Navigation
General Description
This API will allow you access to specific processes within our system.
All data sent to the API must be sent in fields in a POST request.
Authentication
Authentication is achieved by sending a key and secret to the API with each request. You create these credentials in the customer portal in the Profile > API section.
The secret is only available once when creating the API key in the portal, you need to save it for use in your scripts that are accessing the API. If you lose the secret you will need to generate a new one.
Format
All responses are JSON encoded, we may include other formats in the future.
Sandbox
You can name a field sandbox and assign it any non-empty value and the request will be classed as readonly, no changes will be made.
For requests that are only reading and returning data, the maximum number of records returned will be capped at 10 when the sandbox field is set.
When sandbox is set, the value you defined will be returned in the response to acknowledge its existence.