The Cradle customer api can be used for retrieving conversations (call records) from Cradle's database. You can also sign up to receive webhooks of each conversation at the end of every conversation.
\nTo receive API credentials, please chat with us whilst logged into the Cradle admin platform, and we will provide an API ID and Key via a secure channel. You will need to be signed into Cradle to authenticate your user. Requests by email and phone will not be accepted.
\nPlease supply a webhook URL when requesting API access.
\nGenerally, you will want to use the conversations endpoint to access call and user history data. If you are wanting to archive call recordings in your own system, please use the recordings endpoints.
\nPlease respect the api and make no more than 10 requests every second, never have more than 10 concurrent requests in flight at one time, and never make a request until the response from the previous request has been received. Exceeding this limit will result in rate limiting (you may receive 429 responses to your requests).
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"11360917","collectionId":"6ac27f15-a68a-48df-82b2-d1f917f5cc14","publishedId":"Tz5p6xqX","public":true,"customColor":{"top-bar":"240D50","right-sidebar":"240D50","highlight":"FF7057"},"publishDate":"2022-07-11T00:13:49.000Z"},"item":[{"name":"conversations","item":[{"name":"Get Conversation List","id":"a0d404ca-2332-4e84-81c4-fa0ce85d95c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"CRADLE_API_KEY"},{"key":"value","value":"your_api_key"}]},"isInherited":false},"method":"GET","header":[{"key":"CRADLE_ID","value":"your_id","type":"text"}],"url":"https://api.cradle.io/api/v1/public/conversations?from=2022-06-01T00:00:00.000Z&until=2022-06-01T12:00:00.000Z","description":"Returns the list of conversations for the selected dates. Each conversation can have the following fields.
\nDetails of thirdPartyNumbers
Details of users
Use this endpoint to pull full lists of all conversations your team have had, and their participation in those conversations. Recommended for:
\nIf subscribed to a webhook, you will receive the same information within each conversation at the end of the conversation. Webhooks will be retried up to three times over a 24 hour period, if unsuccessful, and thereafter will be dropped.
\n","_postman_id":"13841652-9d15-4166-a389-1b8b47c7af30"},{"name":"recording","item":[{"name":"Get Recording List","id":"b113e4be-018b-4499-a13d-e2639e6258df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"CRADLE_API_KEY"},{"key":"value","value":"your_api_key"}]},"isInherited":false},"method":"GET","header":[{"key":"CRADLE_ID","value":"your_id","type":"text"}],"url":"https://api.cradle.io/api/v1/public/recordings?from=2022-06-01T00:00:00.000Z&until=2022-06-01T12:00:00.000Z","description":"Returrns the list of recording for the selected dates
\n","urlObject":{"path":["api","v1","public","recordings"],"host":["https://api.cradle.io"],"query":[{"key":"from","value":"2022-06-01T00:00:00.000Z"},{"key":"until","value":"2022-06-01T12:00:00.000Z"}],"variable":[]}},"response":[{"id":"bea695cd-62ab-4f78-8e80-b71180cf1c8f","name":"Get Recording List","originalRequest":{"method":"GET","header":[{"key":"CRADLE_ID","value":"your_id","type":"text"},{"key":"CRADLE_API_KEY","value":"your_api_key","type":"text"}],"url":{"raw":"https://api.cradle.io/api/v1/public/recordings?from=2019-03-10T02:08:00.000Z&until=2019-10-13T02:28:00.000Z","protocol":"https","host":["api","cradle","io"],"path":["api","v1","public","recordings"],"query":[{"key":"from","value":"2019-03-10T02:08:00.000Z"},{"key":"until","value":"2019-10-13T02:28:00.000Z"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Thu, 11 Mar 2021 23:22:26 GMT"},{"key":"Content-Length","value":"551"}],"cookie":[],"responseTime":null,"body":"{\n \"recordings\": [\n {\n \"url\": \"https://api.cradle.io/api/v1/public/recordings/935f1dc8-b56a-535c-b678-95edf74c593c.mp3?source=api\",\n \"startedAt\": \"2021-03-11T00:18:39Z\",\n \"durationSeconds\": 189,\n \"cradleNumber\": \"+14152125161\",\n \"thirdPartyNumber\": \"+14155555161\",\n \"agent1\": \"user1@cradle.io\",\n \"nature\": \"in\"\n },\n {\n \"url\": \"https://api.cradle.io/api/v1/public/recordings/936f1dc8-b56a-535c-b678-95edf74c593c.mp3?source=api\",\n \"startedAt\": \"2021-03-11T00:18:59Z\",\n \"durationSeconds\": 154,\n \"cradleNumber\": \"+14152125161\",\n \"thirdPartyNumber\": \"+14155555161\",\n \"agent1\": \"user1@cradle.io\",\n \"nature\": \"out\"\n },\n {\n \"url\": \"https://api.cradle.io/api/v1/public/recordings/937f1dc8-b56a-535c-b678-95edf74c593c.mp3?source=api\",\n \"startedAt\": \"2021-03-11T00:19:59Z\",\n \"durationSeconds\": 417,\n \"agent1\": \"user1@cradle.io\",\n \"agent2\": \"user2@cradle.io\",\n \"nature\": \"team\"\n }\n ],\n \"size\": 3\n}"}],"_postman_id":"b113e4be-018b-4499-a13d-e2639e6258df"},{"name":"Get Recording","id":"95a0f2e2-ed9f-499f-9b17-67cef3689967","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"CRADLE_API_KEY"},{"key":"value","value":"your_api_key"}]},"isInherited":false},"method":"GET","header":[{"key":"CRADLE_ID","value":"your_id","type":"text"}],"url":"https://api.cradle.io/api/v1/public/recordings/recording_id.mp3?source=api","description":"Return a recording URL by uuid.
\nNote that this API returns files of sizes up to 100 MB, which may take many seconds to respond to.
\n","urlObject":{"path":["api","v1","public","recordings","recording_id.mp3"],"host":["https://api.cradle.io"],"query":[{"key":"source","value":"api"}],"variable":[]}},"response":[{"id":"fc3d15da-bce0-45dd-a94f-a3a8ed5e6323","name":"Get Recording","originalRequest":{"method":"GET","header":[{"key":"CRADLE_ID","value":"your_id","type":"text"},{"key":"CRADLE_API_KEY","value":"your_api_key","type":"text"}],"url":{"raw":"https://api.cradle.io/api/v1/public/recordings/11bd5c0c-1fe9-593e-b0df-cc91a3ed5f29.mp3?source=api","host":["https://api.cradle.io"],"path":["api","v1","public","recordings","11bd5c0c-1fe9-593e-b0df-cc91a3ed5f29.mp3"],"query":[{"key":"source","value":"api"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"95a0f2e2-ed9f-499f-9b17-67cef3689967"}],"id":"ab570372-195e-4e52-99a4-09f70e4ebe2f","description":"These two endpoints are specific to those wishing to archive all recordings. The list of conversations may not be complete as any that don't have a recording are not returned.
\nEach recording will be returned with information specific to the recording. Some conversations will have multiple recordings, for example those that are transferred between users.
\n","_postman_id":"ab570372-195e-4e52-99a4-09f70e4ebe2f"}],"event":[{"listen":"prerequest","script":{"id":"8500464b-8de4-47f3-8218-944443eda5ee","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cb36409c-888f-4829-a4bd-620953fb5005","type":"text/javascript","exec":[""]}}],"variable":[{"key":"host","value":"https://api.cradle.io","type":"string"},{"key":"cradle_id","value":"your_id","type":"string"},{"key":"cradle_api_key","value":"your_api_key","type":"string"},{"key":"from","value":"2022-06-01T00:00:00.000Z","type":"string"},{"key":"to","value":"2022-06-01T12:00:00.000Z","type":"string"},{"key":"recording_id","value":"recording_id"}]}