Overview
Welcome to our API documentation. Our CloudCall API allows application developers and systems to create a fully functional Computer telephony integrated (CTI) solution over a uniform, commonly understood Web transport mechanism (namely, REST).
For more information on REST, see the Wikipedia article and the paper that first codified it.
For any queries about using our API or this documentation, please send an email to integrations@cloudcall.com.
Authentication
Our CloudCall REST API authenticate using Username, Password and LicenseKey. When you Sign Up with CloudCall, you will be allocated an account number and password , that you use to login to the CloudCall Portal. Once you are set up, you can then login to our portal and create an License key that is specific for your applicaiton. Within our documentation, you can specify these at the very top of the page, which will then be used to format request urls for API calls if possible. You can also specify the environment you wish to send your calls to.
All requests sent in to our API require you to specify the following values in the request header, otherwise a 403 forbidden will be returned.
- Username: The account number (e.g. 44xxxxxxxxxx)
- Password: The password used to log into the specified account
- License Key: You can generate a License Key via the CloudCall Portal under API integrations
Any other parameters, unless specified in the details below, must be passed in the body as serialised JSON or as query parameters. All returned values will also be passed as JSON.
Example
curl -XGET -H "Username: 441234567890" -H "Password: a1b2c3d4e5f6" -H "Licensekey: a1b2c3d4-e5f6-g7h8-i9j1-0k11l12m13yz" "/api.uk.cloudcall.com/Accounts/441234567890/"
Urls
We have two API's' that are country specific, the URLs for accessing the APIâs are as follows:
| Platform | URL |
|---|---|
| UK | /api.uk.cloudcall.com/ |
| US | /api.us.cloudcall.com/ |
CloudCall Parameter Tags
| A text value, such as a name or email address | |
| A date value, dates must be passed into our API in the format YYYY-MM-DD. e.g. 2016-12-25 | |
| A date-time value, date-times must be passed into our API in the format YYYY-MM-DDTHH:mm:ss. e.g. 2016-12-25T08:12:45 | |
| A time value, times must be passed into our API in the format HH:mm:ss. e.g. 08:12:45 | |
| A numerical value, usually used to represent an id or count | |
| A numerical value allowing decimal places | |
| A boolean value, passed in to our system as the strings 'true' or 'false' | |
| This is a custom data structure used by the API, click on the tag to find out more about the entity | |
| An optional parameter, a default value will be used in some cases if a value is not provided | |
| A required parameter, the request will throw an error if these are not provided | |
| This indicates that the fields can be nullable | |
| This indicates a read only field that can not be set via the API | |
| This indicates that the field have been deprecated. |
Acronyms
Definition of acronyms used throughout the documentation.
| Acronym | Definition |
|---|---|
| CLD | Outbound Identifier of the call / phone number to call. |
| CLI | Inbound Identitier of the call / phone number to call from. |
| JWT | JSON Web Token: JSON-based open standard for creating access tokens. |
| DDI | Direct Dial In numbers are additional numbers that allow calls to bypass the operator and be directed straight to the required extension. |