.png?sv=2022-11-02&spr=https&st=2025-06-13T02%3A29%3A11Z&se=2025-06-13T02%3A39%3A11Z&sr=c&sp=r&sig=qpMtMi%2FwIE4uxSy1Vkw6BM2WeRQypWFz08BvwvmGvCk%3D){kind=logo}
Get Call Information
- DarkLight
Get Call Information
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
This API provides information about an Outbound Call.
Pre-requisite
The Agent must be on an active outbound call.
Sequence Diagram
Message Structure
Request Parameters | Value |
|---|---|
channel | LCM |
topic | Outbound |
subtopic | OutBoundCallStateChange |
source | «app-name-broadcasting-this-message» |
data | «placeholder» |
Data Parameters
Parameters | Mandatory Y/N | Data Type | Description | Example Data |
|---|---|---|---|---|
call | Yes | Json Object | Current call object. | |
source | Yes | String | Source of response. | |
Call Parameters | ||||
ButtonStates | Yes | Json Object | Call Button states. | |
ActionsAllowed | No | NA | NA | |
ResponseType | No | NA | NA | |
ResponseText | No | NA | NA | |
ResponseActual | No | NA | NA | |
CallVariables | Yes | Json Object | List of business fields. | |
ExtendedCallVariables | No | NA | NA | |
ResponseFields | Yes | Json Object | Call information object. | |
User | Yes | Json Object | Agent information object. | |
id | Yes | String | Connection ID. | |
event | Yes | String | LCM event configured corresponding to CTI event. | |
CallType | Yes | String | LCM call type configured corresponding to CTI call type. | |
ButtonStates Parameters | ||||
items | Yes | Json Object | Call Button items with their states. | |
count | Yes | String | The count of call buttons. | |
ResponseFields Parameters | ||||
Participants | No | NA | NA | |
MediaProperties | Yes | Json Object | Call properties. | |
fromAddress | No | String | Tethered phone number. | |
toAddress | No | String | Customer phone number. | |
CallState | Yes | String | Connection state. | |
Type | Yes | String | Connection Type - Outbound. | |
CallStartTime | Yes | String | Call Start Time in UTC format. | |
CurrentStateTime | Yes | String | Current state change time in UTC format. | |
CallDurationInSec | Yes | String | Call duration, in seconds. | |
StateDuration | Yes | String | Call duration in HH:MM format. | |
CurrentStateDuration | Yes | String | Current state duration in HH:MM format. | |
LocaleStartTime | Yes | String | Call start time in local time zone. | |
LocaleLastStateTime | Yes | String | Current state time in local time zone. | |
Campaign | No | String | LCM campaign name. | |
DN | No | NA | NA | |
OutboundType | No | String | The outbound pacing mode - Preview, Predictive, or Progressive. | |
CampaignGroup | No | String | LCM campaign group. | |
LCMKey | Yes | String | The LCM key. | |
CallAgent | No | String | The name of the agent handling the call. | |
ConsultAgent | Yes | String | The name of the consult agent. | |
ContactNature | No | String | The call nature. | |
CustUUID | No | String | Customer connection UUID. | |
AgentUUID | No | String | Agent connection UUID. | |
PreviewDuration | No | Number | The duration of the timed preview. | |
ACWDuration | No | Number | The duration of the ACW by the agent. | |
MediaPropertiesParameters | ||||
callType | Yes | String | The CTI call type. | |
queuename | Yes | String | The queue name for the current call. | |
queueTimestamp | NA | NA | NA | |
UserParameters | ||||
UserId | Yes | String | The agent user name. | |
Sample Response
{
"channel": "LCM",
"topic": "OutboundCall",
"subtopic": "OutBoundCallStateChange",
"message": {
"call": {
"ButtonStates": {
"items": {
"makeCall": "Hide",
"skip": "Hide",
"close": "Hide",
"disconnect": "Hide",
"hold": "Hide",
"resume": "Hide",
"consult": "Hide",
"consultDrop": "Hide",
"transfer": "Hide",
"conference": "Hide",
"clearContact": "Hide"
},
"count": 11
},
"ActionsAllowed": null,
"ResponseType": 0,
"ResponseText": "Success",
"ResponseActual": {
"data": {
"ContactNumber": "914461084454",
"LCMKey": "5|3|1|0|0|44|1",
"Agent": "AECAgent",
"ConsultAgent": "",
"CallStatus": "completed",
"ContactNature": "Re-Scheduled",
"ContactType": "TRANSFER",
"TimedPreview": 0,
"CustUUID": "881307f2-af5a-4772-a936-4b3e838bdced",
"CustCallQueue": "Queue1",
"CPA_Detection": true,
"AMDTreatment": "Transfer to Agent",
"DataCenterAPIURL": "https://api-us-1.nexmo.com",
"machineDetectionTimeout": 2000,
"FromNumber": "12012548348",
"isCallDropped": false,
"Campaignid": "SamplePredictiveCampaign",
"CampaignGroup": "Queue1",
"PacingMode": "PREDICTIVE",
"AgentUUID": "370d958b-a566-4cab-96b2-e3855aa93003",
"ConsultAgentUUID": "",
"CallAgent": "AECAgent",
"AgentDataCenter": "https://api-us-1.nexmo.com",
"ConsultAgentDataCenter": "",
"StartTime": "2020-06-18T13:03:43.5593415+00:00",
"StateChangedTime": "2020-06-18T13:05:19.1682325+00:00",
"AgentConfID": "AECAgent",
"ConsultConfID": "",
"ContactID": 5,
"BusinessFields": [
{
"FieldName": "FName",
"FieldID": "1",
"Value": "David1"
},
{
"FieldName": "LName",
"FieldID": "2",
"Value": "Berry"
},
{
"FieldName": "Country",
"FieldID": "3",
"Value": "USA"
}
],
"CallType": "Regular-Call"
},
"actions": {
"Buttons": [],
"AgentState": "Enable",
"Timer": {
"HideStateChangeTimer": true,
"StateChangeTimer": true
},
"Refresh": 0
}
},
"CallVariables": {
"FName": "David1",
"LName": "Berry",
"Country": "USA"
},
"ExtendedCallVariables": null,
"ResponseFields": {
"Participants": [],
"MediaProperties": {
"callType": "Regular-Call",
"queueName": "Queue1",
"queueTimestamp": ""
},
"fromAddress": "12012548348",
"toAddress": "914461084454",
"CallState": "DROPPED",
"Type": "outbound",
"CallStartTime": "2020-06-18T13:03:43.5593415+00:00",
"CurrentStateTime": "2020-06-18T13:05:19.1682325+00:00",
"CallDurationInSec": 100,
"StateDuration": "01:40",
"CurrentStateDuration": "00:05",
"LocaleStartTime": "6/18/2020 6:33:43 PM",
"LocaleLastStateTime": "6/18/2020 6:35:19 PM",
"DN": "",
"Campaign": "SamplePredictiveCampaign",
"OutBoundType": "PREDICTIVE",
"CampaignGroup": "Queue1",
"LCMKey": "5|3|1|0|0|44|1",
"CallAgent": "AECAgent",
"ConsultAgent": "",
"ContactNature": "Re-Scheduled",
"CustUUID": "881307f2-af5a-4772-a936-4b3e838bdced",
"AgentUUID": "370d958b-a566-4cab-96b2-e3855aa93003"
},
"User": {
"UserId": "AECAgent"
},
"id": "5|3|1|0|0|44|1",
"event": "DROPPED",
"CallType": "Outbound",
"BusinessFields": [
{
"FieldName": "FName",
"Value": "Test",
"DataType": "String",
"Format": "",
"Editable": true
},
{
"FieldName": "LName",
"Value": "Berry",
"DataType": "String",
"Format": "",
"Editable": true
}
],
"OptionalBusinessFields": {
"FName": "David1",
"LName": "Berry",
"Address": "Virginia",
"Home": "6491462346",
"Office": ""
}
},
"source": "event"
}
}Was this article helpful?