GET /API/CALL
Search for call(s) within the search criteria.
QUERY STRING PARAMETERS
| afterid optional | After retrieving a previous result set, include only records after the previous maximum id. |
|---|---|
| maxresults optional | The maximum amount of records to return. The default value is 100 with a maximum value of 1,000. |
| datetimemin optional | Only return records on or after this time within the timezone of the authenticated user. Format is ISO, e.g. 2013-05-01 1:12:00. |
| datetimeminutc optional | Only return records on or after this time in UTC. Format is ISO, e.g. 2013-05-01 1:12:00. |
| datetimemax optional | Only return records on or before this time within the timezone of the authenticated user. Format is ISO, e.g. 2013-05-01 1:12:00. |
| datetimemaxutc optional | Only return records on or before this time in UTC. Format is ISO, e.g. 2013-05-01 1:12:00. |
| callerphonenumber optional | Only return records matching this caller phone number. |
| callername optional | Only return records matching this caller name. |
| destinationphonenumber optional | Only return records matching this destination phone number. |
| destinationname optional | Only return records matching this destination name. |
| subject optional | Only return records matching this subject. |
| rating optional | Only return records matching this rating. Values are in the range of 0 – 5. |
| direction optional | Values can be ‘incoming’, ‘outgoing’ and ‘internal’. |
| handsetgroup optional | Only return records matching handsets within the provided handset group name. |
| tag optional | Only return records containing this tag. |
RESULT CODE
| 200 | OK |
|---|---|
| 401 | Unauthorized |
| 406 | SSL must be used |
| 500 | Server Error |
RESULT BODY
| id | The unique call id. This will be needed when calling other api functions. |
|---|---|
| startdatetime | The time that the call began. The time is reported in the timezone configured for the authenticated user. |
| startdatetimeutc | The time that the call began. The time is reported as UTC. |
| durationseconds | The duration of the call in seconds. |
| callerphonenumber | The caller party phone number. |
| callername | The caller party name. |
| destinationphonenumber | The destination party phone number. |
| destinationname | The destination party name. |
| subject | The subject of the call. |
| rating | The rating of the call. Values are in the range of 0 – 5. |
| audiomd5hash | The md5 hash of the call audio. This can be used to compare a reproduction at a later time for authenticity. |
| audiolengthbytes | The length of the audio recording in bytes. |
| tags | An array of selected tags. |
EXAMPLE REQUEST
Example;-
GET
https://api.calln.com/api/call?datetimemin=2013-05-01%201%3A12%3A0&datetimemax=2013-06-01%201%3A12%3A0&maxresults=5
Result;-
200 (OK)
[{“id”:11341470, “startdatetime”:”2013-05-01 1:12:06″, “startdatetimeutc”:”2013-04-30 15:12:06″, “durationseconds”:73, “callerphonenumber”:”14800105″, “callername”:”Ext 247″, “destinationphonenumber”:”6624870775″, “destinationname”:””, “notes”:””, “rating”:0, “audiomd5hash”:”14e6970f132bce6b03c09dfa9f2a86a5″, “audiolengthbytes”:220217},{“id”:11341484, “startdatetime”:”2013-05-01 1:13:31″, “startdatetimeutc”:”2013-04-30 15:13:31″, “durationseconds”:17, “callerphonenumber”:”14800109″, “callername”:”Ext 246″, “destinationphonenumber”:”18008658715″, “destinationname”:””, “notes”:””, “rating”:0, “audiomd5hash”:”122ce5b9efa7f6e6d56d6f7331be4a4f”, “audiolengthbytes”:52386},{“id”:11341571, “startdatetime”:”2013-05-01 1:12:19″, “startdatetimeutc”:”2013-04-30 15:12:19″, “durationseconds”:39, “callerphonenumber”:”erica.lee”, “callername”:”Erica Lee”, “destinationphonenumber”:”12102885507″, “destinationname”:””, “notes”:””, “rating”:0, “audiomd5hash”:”0d8afe1eeefdec843238a796d09a6108″, “audiolengthbytes”:118269},{“id”:11341575, “startdatetime”:”2013-05-01 1:12:35″, “startdatetimeutc”:”2013-04-30 15:12:35″, “durationseconds”:30, “callerphonenumber”:”9″, “callername”:””, “destinationphonenumber”:”2111″, “destinationname”:””, “notes”:””, “rating”:0, “audiomd5hash”:”ea60beeb28cecc50aef314cbea760ac6″, “audiolengthbytes”:90848},{“id”:11341577, “startdatetime”:”2013-05-01 1:12:55″, “startdatetimeutc”:”2013-04-30 15:12:55″, “durationseconds”:13, “callerphonenumber”:”10470035″, “callername”:”bvllc35″, “destinationphonenumber”:”6013211950″, “destinationname”:””, “notes”:””, “rating”:0, “audiomd5hash”:”16665b5b49b36e2cafc06dc0b302d642″, “audiolengthbytes”:40721}]
USING CURL
curl "https://api.calln.com/call?datetimemin=2013-05-01%201%3A12%3A0&datetimemax=2013-06-01%201%3A12%3A0&maxresults=5" -H "Authorization: Basic username:password | base64" -X GET
