Introduction
The Ringio CRM API is a RESTful API that allows you to read and write Ringio data, such as contacts, notes, phone calls and users.
With the API you can develop integrations with CRM systems, such that when Ringio users get phone calls, the callers can be identified from information stored in a CRM system. You can also enrich the CRM with data captured by Ringio, such as logging phone calls as interaction records in the CRM.
You can use the API privately, for your own purposes, or you can publish your API integration as a plugin in the Ringio CRM Marketplace.
Getting Started
To use the API you need a Ringio account (sign up, let us know and we’ll make your account Lucky Free) and a security token.
Sign up for Ringio. Then click on Plugin Marketplace. Then click on Create my own plugin. Then enable API access to your account data. More about authentication.
With this token you have access to your own data. If you want to access other’s data you will need to publish your plugin, and the administrators of the accounts you wish to access will have to authorize your plugin.
Format
The REST API is implemented as JSON over HTTP using all four REST verbs – GET, POST, PUT and DELETE. Every resource, like contact, note or ring, has their own URL and is manipulated in isolation. In addition, for most resources, we offer a helper Feed that will return a delta or aggregated view of what has changed since the last time that the feed was called. E.g. : HTTP GET http://api.ringio.com/feeds/users/{userId}/contacts?since={timestamp} returns the contacts for a given user that have been created, updated and deleted since the indicated timestamp.
All timestamps sent to and returned from the API are formatted using ISO 8601.
Response codes
- 200: You get this response code if the HTTP request was successful.
- 404: You get this response code if the id is not found (or is found, but it belongs to an account your code is not authorized to access.
- 500: You get this response code if an error happens in the server or if the data presented to the server is invalid or missing.
Data Model
