Get Commuication
This request returns information of a communication event.
The contents of the attachments of the communication are not included in the response of this request. Attachment contents can be retrieved with a get attachment request.
Resource
GET /communications/<ID>
Where ID is the object ID of the communication or the call ID of the call log.
The object ID (OID) of the communication is a part of the resource URL. This OID can be retrieved by a search request.
A search request contains the URL’s of the communicaiton events.
The call ID (callId) of communication is shown in the sip headers of an active call. When you are the initiator of this call, you should prefix this id by "caller_".
When you are not the initiator the ID is for example "186ba647df1ef222" and when you are the initiator the ID is "caller_186ba647df1ef222".
Parameters
| Name | Type | Description |
|---|---|---|
|
Boolean |
Set the retrieved boolean of this communcation to true. The retrieved boolean is used to count the new received communcations. |
Payload
None
Response
Context
| Authorization |
User |
Errors
Example
GET https://xelion.nl/api/v1/master/communications/14142135
{
"object": {
"subject": "2072.csv",
"date": "2018-04-26 15:16:49",
"durationSec": 0,
"incoming": false,
"retrieved": true,
"displayed": true,
"flagged": false,
"hasAttachment": true,
"hasInlineAttachment": false,
"hasMessageReference": true,
"associatedAddressable": {
"commonName": "groep",
"oid": "1737375",
"objectType": "X1Object"
},
"contentSummary": "2072.csv",
"contentSummaryIsComplete": true,
"participants": [
{
"commonName": "",
"role": "rtFrom",
"address": "",
"addressable": {
"commonName": "Wesley Legierse",
"oid": "1650975",
"objectType": "Person"
},
"oid": "1737440",
"objectType": "Addressee"
},
{
"commonName": "",
"role": "rtTo",
"address": "",
"addressable": {
"commonName": "groep",
"oid": "1737375",
"objectType": "X1Object"
},
"oid": "1737441",
"objectType": "Addressee"
},
{
"commonName": "",
"role": "rtTo",
"address": "",
"addressable": {
"commonName": "Arno Brugman",
"oid": "1650938",
"objectType": "Person"
},
"oid": "1737442",
"objectType": "Addressee"
}
],
"attachments": [
{
"originalLocation": "2072.csv",
"mimeType": "",
"size": 0,
"commonName": "2072.csv",
"oid": "1737428",
"objectType": "Attachment"
}
],
"messageReferences": [
{
"permissions": "ReadWriteRemove",
"commonName": "Wesley Legierse",
"x1syncsource": "csv",
"oid": "1650975",
"objectType": "Person"
}
],
"voicemail": false,
"voicemailIsHeard": false,
"phone": "",
"isConferenceCall": false,
"callAnswerTime": "",
"callAnswerTimeSec": 0,
"callEndTime": "",
"onHoldDuration": 0,
"trunk": "",
"phoneLine": {
"permissions": "Read",
"commonName": "Telefoonaansluiting Wesley Legierse",
"oid": "1651226",
"objectType": "XCCPhoneLine"
},
"wrapUpTime": 0,
"afterCallType": "Complaint",
"packetsLog": [
{
"channel": "local received",
"totalPackets": 179,
"lostPackets": 0,
"meanJitterDeviation": 5,
"jitter10Count": 1,
"jitter20Count": 0,
"jitter30Count": 0,
"glitch1": 0,
"glitch2": 0,
"glitch4": 0,
"syncSource": 189376667,
"oid": "1809540",
"objectType": "XCCPacketsLog"
}
],
"permissions": "ReadWriteRemove",
"commonName": "2072.csv",
"oid": "1737437",
"objectType": "XCCUserChat"
},
"links": [
{
"rel": "self",
"href": "https://sip.xelion.nl/api/v1/master/communications/1737437",
"method": "GET"
}
]
}