A basic overview of DialogTech's API design, security, and functionality.
DialogTech's APIs are designed as a REST-like API which provides an XML responses in most scenarios. As the API is accessible via HTTP, any programming language with the ability to make web-service calls can be used to create applications which leverage the various functional and reporting capabilities of DialogTech.
The success/failure of an API call will be described within the XML response to each individual API call.
API Security
DialogTech's REST-like API expects 2 authentication values to be passed in the URL of each API call. The access_key and secret_access_key values can be obtained within your account via DialogTech's Key Manager.
NOTICE
Your Secret Access Key should be protected. It should not be written anywhere that it can be accessed by anyone not authorized to use your DialogTech account. If you think your Secret Access Key has been compromised, you can revoke the key directly within the same interface used to generate API Keys.
All of DialogTech's API Endpoints are available in a secure format only. If a call is made to a non-secure endpoint, the URL will automatically redirect from http:// to https://.
Using DialogTech's Access Keys for API Calls
Access Keys and Secret Access Keys can be managed within your account under the Key Manager. Whenever a web request is made to one of DialogTech's APIs, both the access key, and secret access key must be provided as URL Parameters.
https://secure.dialogtech.com/[endpoint]?access_key=[Your Access Key]&secret_access_key=[Your Secret Access Key]
DialogTech API Types
| API Type | Description |
|---|---|
| Call Initiation APIs | APIs which are used to generate new phone calls utilizing DialogTech's different applications |
| Administration APIs | APIs which are used to purchase add-ons and phone numbers within your account, create and schedule voice broadcasts, as well as create, route, and configure applications and numbers within your DialogTech account |
| Reporting APIs | APIs which are used to get data and reports from your DialogTech account. This includes call detail reporting, IVR reporting, recording downloads, voicemails, and more |
| SMS API | APIs which serve as the interface for DialogTech's SMS functionality including sending SMS, and reporting on both inbound and outbound SMS messages |
| WebHooks | A method of a 3rd party system receiving call information mid-call from DialogTech, and responding with routing instructions for that particular call |