{"_id":"5841072607c5d425007f57b3","user":"56f99ab84d2b4f3400edb636","project":"55c8cff571d7580d0063a5e5","__v":0,"parentDoc":null,"category":{"_id":"5841064b652e5b0f0015a7c8","version":"57624356653c2d2200fec79c","project":"55c8cff571d7580d0063a5e5","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-12-02T05:27:39.040Z","from_sync":false,"order":7,"slug":"call-logs","title":"Account Call Logs"},"version":{"_id":"57624356653c2d2200fec79c","__v":20,"project":"55c8cff571d7580d0063a5e5","createdAt":"2016-06-16T06:12:38.244Z","releaseDate":"2016-06-16T06:12:38.244Z","categories":["57624356653c2d2200fec79d","57624356653c2d2200fec79e","57624356653c2d2200fec79f","57624356653c2d2200fec7a0","57624356653c2d2200fec7a1","57624356653c2d2200fec7a2","57624356653c2d2200fec7a3","57624356653c2d2200fec7a4","57624356653c2d2200fec7a5","57624356653c2d2200fec7a6","57624356653c2d2200fec7a7","57624356653c2d2200fec7a8","57624356653c2d2200fec7a9","57624356653c2d2200fec7aa","5779ca1b99b40b0e005abb3a","5779d198aea88b0e00f63277","5797d3ab17ced017003c4be4","57ac170ef1cdae0e0053cdfc","57dbfc723ed3450e00dc9e6d","5804d12d16161c0f0077df9b","5841064b652e5b0f0015a7c8","588b5e5f2966b2230009cbf9","58a68ebf3239fa0f00857619","58c23c8b4922930f0050ac91","58fd1460809fc30f00f2ee07","5934eaf5328680002d77de6a","594bf91601cfe6000f40f4c5","595c4ed696b447001ba0cf6d","596524495cee50001575f5be","5970d4f1313162004dd303b5","59780fac24dbd1001a1fa057","59a8cfd3ead78a002d63cafe","59e0323d93da1f001c9ec170"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"4.0.0","version":"4"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-12-02T05:31:18.824Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"The Call Logs API returns a list of call detail records for the account. The result includes the id, start time, creation time, caller ID, called number, direction of call, and duration in seconds. If applicable, the result may also include final action, final action duration, listen URL, and/or transcription. \n\nSince the call logs usually contains many calls, API users may use filters such as start_time, created_at and direction to limit the result set to calls interested.  Users may also use the sorting parameters such as start_time and created_at to list result in ascending or descending order. \n\n## Supported Services\n* [List Call Logs](doc:list-account-call-logs) \n* [Get Call Logs](doc:get-account-call-log) \n\n## Summary Object\nThe Call Log Summary Object is used to briefly represent a call. It consists of properties as below:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`id`\",\n    \"0-1\": \"string\",\n    \"0-2\": \"ID\",\n    \"1-0\": \"`uuid`\",\n    \"1-1\": \"String\",\n    \"1-2\": \"Internal system id, may be `null`\",\n    \"2-0\": \"`extension`\",\n    \"2-1\": \"[Extension Summary Object](doc:account-extensions#section-summary-object)\",\n    \"2-2\": \"Account extension\",\n    \"3-0\": \"`caller_id`\",\n    \"3-1\": \"string\",\n    \"3-2\": \"Call made from this phone number\",\n    \"4-0\": \"`called_number`\",\n    \"4-1\": \"string\",\n    \"4-2\": \"Call made to this phone number\",\n    \"5-0\": \"`start_time`\",\n    \"5-1\": \"string\",\n    \"5-2\": \"Call start time\",\n    \"6-0\": \"`created_at`\",\n    \"6-1\": \"string\",\n    \"6-2\": \"Call log creation time.  Same as call end time + time needed to create call log\",\n    \"7-0\": \"`direction`\",\n    \"7-1\": \"string\",\n    \"7-2\": \"Call direction: in or out\",\n    \"8-0\": \"`type`\",\n    \"8-1\": \"string\",\n    \"8-2\": \"Call type: call, fax, audiogram ...\",\n    \"9-0\": \"`call_duration`\",\n    \"9-1\": \"integer\",\n    \"9-2\": \"Call duration in seconds\",\n    \"10-0\": \"`is_monitored`\",\n    \"10-1\": \"Y or N\",\n    \"10-2\": \"Was call being monitored?\",\n    \"11-0\": \"`call_number`\",\n    \"11-1\": \"floating point number\",\n    \"11-2\": \"Internal system call reference number\",\n    \"12-0\": \"`final_action`\",\n    \"12-1\": \"String\",\n    \"12-2\": \"Last action of call flow\",\n    \"13-0\": \"'voicemail_url'\",\n    \"13-1\": \"string\",\n    \"13-2\": \"URL of voicemail if available.  User may download the audio via this URL.  Empty string if voicemail does not exist\",\n    \"16-0\": \"`call_recording_url`\",\n    \"14-0\": \"'voicemail_cp_url'\",\n    \"14-1\": \"string\",\n    \"15-1\": \"string\",\n    \"16-1\": \"string\",\n    \"17-1\": \"string\",\n    \"14-2\": \"URL of voicemail if available.  User may listen to the audio online via this URL.  Empty string if voicemail does not exist\",\n    \"15-0\": \"'voicemail_transcript'\",\n    \"15-2\": \"Transcript of voicemail if enabled and available\",\n    \"17-2\": \"URL of call recording if available.  User may listen to the audio online via this URL.  Empty string if call recording does not exist\",\n    \"16-2\": \"URL of call recording if available.  User may download the audio via this URL.  Empty string if call recording does not exist\",\n    \"17-0\": \"`call_recording_cp_url`\"\n  },\n  \"cols\": 3,\n  \"rows\": 18\n}\n[/block]\nHere is an example:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"id\\\": \\\"28c26910-ffd2-4de1-8161-949e3eb955aa\\\",\\n    \\\"voip_id\\\": 337171,\\n    \\\"extension\\\": {\\n        \\\"id\\\": 709038,\\n        \\\"voip_id\\\": 337171,\\n        \\\"name\\\": \\\"Yuen Home Main\\\",\\n        \\\"extension\\\": 18,\\n    },\\n    \\\"caller_id\\\": \\\"+19732618055\\\",\\n    \\\"called_number\\\": \\\"+17326830492\\\",\\n    \\\"start_time_epoch\\\": 1490031377,\\n    \\\"start_time\\\": \\\"2017-03-20T10:36:17-07:00\\\",\\n    \\\"created_at_epoch\\\": 1490031426,\\n    \\\"created_at\\\": \\\"2017-03-20T10:37:06-07:00\\\",\\n    \\\"direction\\\": \\\"in\\\",\\n    \\\"type\\\": \\\"call\\\",\\n    \\\"call_duration\\\": 24,\\n    \\\"record_duration\\\": 24,\\n    \\\"is_monitored\\\": \\\"Y\\\",\\n    \\\"call_number\\\": \\\"1490031377.4770004\\\",\\n    \\\"final_action\\\": \\\"dial_out SIP/122532x2:::at:::edg-san\\\",\\n    \\\"voicemail_url\\\": null,\\n    \\\"voicemail_cp_url\\\": null,\\n    \\\"voicemail_transcript\\\": null,\\n    \\\"call_recording_url\\\": \\\"/call-logs/28c26910-ffd2-4de1-8161-949e3eb955aa/recording/download\\\",\\n    \\\"call_recording_cp_url\\\": \\\"https://control.phone.com/voip/listen?document_id=58d013426b577c47c0493e91;linked_uuid=28c26910-ffd2-4de1-8161-949e3eb955aa\\\",\\n    \\\"called_nickname\\\": \\\"(732) 683-0492\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n## Full Object\nThe Full Call Log Object includes the properties in the [Call Log Summary Object](#section-summary-object), along with the following:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`details`\",\n    \"0-1\": \"A list of call flows from beginning of call to end of call.\",\n    \"1-0\": \"`caller_cnam`\",\n    \"1-1\": \"Internal system caller id / name\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\nHere is an example:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"id\\\": \\\"28c26910-ffd2-4de1-8161-949e3eb955aa\\\",\\n    \\\"voip_id\\\": 337171,\\n    \\\"extension\\\": {\\n        \\\"id\\\": 709038,\\n        \\\"voip_id\\\": 337171,\\n        \\\"name\\\": \\\"Yuen Home Main\\\",\\n        \\\"extension\\\": 18,\\n    },\\n    \\\"caller_id\\\": \\\"+19732618055\\\",\\n    \\\"called_number\\\": \\\"+17326830492\\\",\\n    \\\"start_time_epoch\\\": 1490031377,\\n    \\\"start_time\\\": \\\"2017-03-20T10:36:17-07:00\\\",\\n    \\\"created_at_epoch\\\": 1490031426,\\n    \\\"created_at\\\": \\\"2017-03-20T10:37:06-07:00\\\",\\n    \\\"direction\\\": \\\"in\\\",\\n    \\\"type\\\": \\\"call\\\",\\n    \\\"call_duration\\\": 24,\\n    \\\"record_duration\\\": 24,\\n    \\\"is_monitored\\\": \\\"Y\\\",\\n    \\\"call_number\\\": \\\"1490031377.4770004\\\",\\n    \\\"final_action\\\": \\\"dial_out SIP/122532x2@edg-san\\\",\\n    \\\"voicemail_url\\\": null,\\n    \\\"voicemail_cp_url\\\": null,\\n    \\\"voicemail_transcript\\\": null,\\n    \\\"call_recording_url\\\": \\\"/call-logs/28c26910-ffd2-4de1-8161-949e3eb955aa/recording/download\\\",\\n    \\\"call_recording_cp_url\\\": \\\"https://control.phone.com/voip/listen?document_id=58d013426b577c47c0493e91;linked_uuid=28c26910-ffd2-4de1-8161-949e3eb955aa\\\",\\n    \\\"called_nickname\\\": \\\"(732) 683-0492\\\",\\n    \\\"caller_cnam\\\": \\\"\\\",\\n    \\\"details\\\": [\\n        {\\n            \\\"start_time\\\": 1490031378,\\n            \\\"type\\\": \\\"phone\\\",\\n            \\\"voip_phone_id\\\": 709038,\\n            \\\"id_value\\\": 709038,\\n            \\\"voip_id\\\": 337171\\n        },\\n        {\\n            \\\"voip_id\\\": 337171,\\n            \\\"caller_id\\\": \\\"+19732618055\\\",\\n            \\\"voip_phone_id\\\": 709038,\\n            \\\"called_number\\\": \\\"SIP/122532x2@edg-san\\\",\\n            \\\"type\\\": \\\"dial_out\\\",\\n            \\\"start_time\\\": 1490031378\\n        }\\n    ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n## Call Details Object\nEach item in the 'details' record may contain the following properties:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`start_time`\",\n    \"0-1\": \"UNIX time stamp representing the UTC time that this call item starts\",\n    \"1-0\": \"`type`\",\n    \"1-1\": \"Endpoint for this call item, such as call, voicemail, fax, menu, menu item, queue ...\",\n    \"2-0\": \"`id_value`\",\n    \"2-1\": \"ID associated with this call item endpoint (type)\",\n    \"3-0\": \"`voip_id`\",\n    \"3-1\": \"Same as account id\",\n    \"4-0\": \"`voip_phone_id`\",\n    \"4-1\": \"Same as account extension id\",\n    \"5-0\": \"\",\n    \"5-1\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]","excerpt":"","slug":"account-call-logs","type":"basic","title":"Call Logs"}
The Call Logs API returns a list of call detail records for the account. The result includes the id, start time, creation time, caller ID, called number, direction of call, and duration in seconds. If applicable, the result may also include final action, final action duration, listen URL, and/or transcription. Since the call logs usually contains many calls, API users may use filters such as start_time, created_at and direction to limit the result set to calls interested. Users may also use the sorting parameters such as start_time and created_at to list result in ascending or descending order. ## Supported Services * [List Call Logs](doc:list-account-call-logs) * [Get Call Logs](doc:get-account-call-log) ## Summary Object The Call Log Summary Object is used to briefly represent a call. It consists of properties as below: [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-0": "`id`", "0-1": "string", "0-2": "ID", "1-0": "`uuid`", "1-1": "String", "1-2": "Internal system id, may be `null`", "2-0": "`extension`", "2-1": "[Extension Summary Object](doc:account-extensions#section-summary-object)", "2-2": "Account extension", "3-0": "`caller_id`", "3-1": "string", "3-2": "Call made from this phone number", "4-0": "`called_number`", "4-1": "string", "4-2": "Call made to this phone number", "5-0": "`start_time`", "5-1": "string", "5-2": "Call start time", "6-0": "`created_at`", "6-1": "string", "6-2": "Call log creation time. Same as call end time + time needed to create call log", "7-0": "`direction`", "7-1": "string", "7-2": "Call direction: in or out", "8-0": "`type`", "8-1": "string", "8-2": "Call type: call, fax, audiogram ...", "9-0": "`call_duration`", "9-1": "integer", "9-2": "Call duration in seconds", "10-0": "`is_monitored`", "10-1": "Y or N", "10-2": "Was call being monitored?", "11-0": "`call_number`", "11-1": "floating point number", "11-2": "Internal system call reference number", "12-0": "`final_action`", "12-1": "String", "12-2": "Last action of call flow", "13-0": "'voicemail_url'", "13-1": "string", "13-2": "URL of voicemail if available. User may download the audio via this URL. Empty string if voicemail does not exist", "16-0": "`call_recording_url`", "14-0": "'voicemail_cp_url'", "14-1": "string", "15-1": "string", "16-1": "string", "17-1": "string", "14-2": "URL of voicemail if available. User may listen to the audio online via this URL. Empty string if voicemail does not exist", "15-0": "'voicemail_transcript'", "15-2": "Transcript of voicemail if enabled and available", "17-2": "URL of call recording if available. User may listen to the audio online via this URL. Empty string if call recording does not exist", "16-2": "URL of call recording if available. User may download the audio via this URL. Empty string if call recording does not exist", "17-0": "`call_recording_cp_url`" }, "cols": 3, "rows": 18 } [/block] Here is an example: [block:code] { "codes": [ { "code": "{\n \"id\": \"28c26910-ffd2-4de1-8161-949e3eb955aa\",\n \"voip_id\": 337171,\n \"extension\": {\n \"id\": 709038,\n \"voip_id\": 337171,\n \"name\": \"Yuen Home Main\",\n \"extension\": 18,\n },\n \"caller_id\": \"+19732618055\",\n \"called_number\": \"+17326830492\",\n \"start_time_epoch\": 1490031377,\n \"start_time\": \"2017-03-20T10:36:17-07:00\",\n \"created_at_epoch\": 1490031426,\n \"created_at\": \"2017-03-20T10:37:06-07:00\",\n \"direction\": \"in\",\n \"type\": \"call\",\n \"call_duration\": 24,\n \"record_duration\": 24,\n \"is_monitored\": \"Y\",\n \"call_number\": \"1490031377.4770004\",\n \"final_action\": \"dial_out SIP/122532x2@edg-san\",\n \"voicemail_url\": null,\n \"voicemail_cp_url\": null,\n \"voicemail_transcript\": null,\n \"call_recording_url\": \"/call-logs/28c26910-ffd2-4de1-8161-949e3eb955aa/recording/download\",\n \"call_recording_cp_url\": \"https://control.phone.com/voip/listen?document_id=58d013426b577c47c0493e91;linked_uuid=28c26910-ffd2-4de1-8161-949e3eb955aa\",\n \"called_nickname\": \"(732) 683-0492\"\n}", "language": "json" } ] } [/block] ## Full Object The Full Call Log Object includes the properties in the [Call Log Summary Object](#section-summary-object), along with the following: [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "`details`", "0-1": "A list of call flows from beginning of call to end of call.", "1-0": "`caller_cnam`", "1-1": "Internal system caller id / name" }, "cols": 2, "rows": 2 } [/block] Here is an example: [block:code] { "codes": [ { "code": "{\n \"id\": \"28c26910-ffd2-4de1-8161-949e3eb955aa\",\n \"voip_id\": 337171,\n \"extension\": {\n \"id\": 709038,\n \"voip_id\": 337171,\n \"name\": \"Yuen Home Main\",\n \"extension\": 18,\n },\n \"caller_id\": \"+19732618055\",\n \"called_number\": \"+17326830492\",\n \"start_time_epoch\": 1490031377,\n \"start_time\": \"2017-03-20T10:36:17-07:00\",\n \"created_at_epoch\": 1490031426,\n \"created_at\": \"2017-03-20T10:37:06-07:00\",\n \"direction\": \"in\",\n \"type\": \"call\",\n \"call_duration\": 24,\n \"record_duration\": 24,\n \"is_monitored\": \"Y\",\n \"call_number\": \"1490031377.4770004\",\n \"final_action\": \"dial_out SIP/122532x2@edg-san\",\n \"voicemail_url\": null,\n \"voicemail_cp_url\": null,\n \"voicemail_transcript\": null,\n \"call_recording_url\": \"/call-logs/28c26910-ffd2-4de1-8161-949e3eb955aa/recording/download\",\n \"call_recording_cp_url\": \"https://control.phone.com/voip/listen?document_id=58d013426b577c47c0493e91;linked_uuid=28c26910-ffd2-4de1-8161-949e3eb955aa\",\n \"called_nickname\": \"(732) 683-0492\",\n \"caller_cnam\": \"\",\n \"details\": [\n {\n \"start_time\": 1490031378,\n \"type\": \"phone\",\n \"voip_phone_id\": 709038,\n \"id_value\": 709038,\n \"voip_id\": 337171\n },\n {\n \"voip_id\": 337171,\n \"caller_id\": \"+19732618055\",\n \"voip_phone_id\": 709038,\n \"called_number\": \"SIP/122532x2@edg-san\",\n \"type\": \"dial_out\",\n \"start_time\": 1490031378\n }\n ]\n}", "language": "json" } ] } [/block] ## Call Details Object Each item in the 'details' record may contain the following properties: [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "`start_time`", "0-1": "UNIX time stamp representing the UTC time that this call item starts", "1-0": "`type`", "1-1": "Endpoint for this call item, such as call, voicemail, fax, menu, menu item, queue ...", "2-0": "`id_value`", "2-1": "ID associated with this call item endpoint (type)", "3-0": "`voip_id`", "3-1": "Same as account id", "4-0": "`voip_phone_id`", "4-1": "Same as account extension id", "5-0": "", "5-1": "" }, "cols": 2, "rows": 5 } [/block]