- DarkLight
Call Event Parameters
- DarkLight
This API contains response message for all call requests.
Message Structure
Parameters | Mandatory | Data Type | Description |
---|---|---|---|
subtopic | Yes | String | Name of the subtopic. InboundCallStateChange. |
channel | Yes | String | Name of channel. Amazon. |
topic | Yes | String | Name of topic. InboundCall. |
message | Yes | JSON Object | Call event message. |
Message Parameters | |||
call | Yes | Json Object | Current call object. |
source | Yes | String | Source of response. |
Call Parameters | |||
Call Parameters | Yes | Json Object | Call Button states. |
Call Button states | No | NA | NA |
ResponseType | No | NA | NA |
ResponseText | No | NA | NA |
ResponseActual | No | NA | NA |
CallVariables | Yes | JSON Object | Call variable list. |
ExtendedCallVariables | No | NA | NA |
ResponseFields | No | JSON Object | Call information object. |
id | Yes | String | Connection ID. |
event | Yes | String | Connection Event. It can be connecting, missed, connected, Rejected, hold, ACW, Dropped. |
CallType | Yes | String | Connection Type. Agent, inbound, outbound |
ButtonStates Parameters | |||
items | Yes | JSON Object | Call Button items with their states. |
count | Yes | Number | Count of buttons. |
ResponseFields Parameters | |||
Participants | No | NA | NA |
MediaProperties | Yes | JSON Object | Properties of call. |
fromAddress | Yes | String | Connection phone number. |
CallState | Yes | String | Connection state. |
Type | Yes | String | Connection Type. Agent, inbound and outbound |
CurrentStateTime | Yes | String | Connection state change time. |
Campaign | No | NA | NA |
DN | Yes | String | Queue name of current call. |
MediaProperties Parameters | |||
callType | Yes | String | Connection Type. Agent, inbound and outbound. |
queueName | Yes | String | Queue name of current call. |
queueTimestamp | Yes | String | Time when customer call added in queue. |