.png?sv=2022-11-02&spr=https&st=2025-12-29T16%3A59%3A13Z&se=2025-12-29T17%3A09%3A13Z&sr=c&sp=r&sig=RF5%2F4TuauBWncpaBPdpbmCKzIwhJrRYqE%2BqfR%2BG3F7w%3D){kind=logo}
Call Event Parameters
- DarkLight
Call Event Parameters
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
This event is triggered when an Agent receives an incoming call.
Pre-requisite
The agent must be in the Ready state.
Sequence Diagram
Message Structure
Request Parameters | Value |
|---|---|
No request parameter |
Response Parameters | Value |
|---|---|
channel | Five9 |
topic | Inbound |
subtopic | InboundCallStateChange |
message | JSON Object |
Message Parameters
Parameter | Data Type | Description | Sample Value |
|---|---|---|---|
call | JSON Object | Current call object | Refer the Call Parameters table. |
source | String | Source of response | event |
Call Parameters
Parameter | Data Type | Description | Sample Value |
|---|---|---|---|
ResponseActual | JSON Object | The actual response value returned from the Five9 API. | Refer the Response Actual Parameters table. |
CallVariables | JSON Object | Contains all the associated call variables in the form of key-value pairs with customizable fields. | |
ResponseFields | JSON Object | Call information object within the response. | Refer the Response Fields Parameters table. |
id | String | The unique ID for the call session generated by Five9. | 94EC5C196B8F4AF2B8213CEB2E3A02EF |
event | String | The name of any one of the events received from Five9. | offered, talking, finished |
CallType | String | The type of call. | Inbound |
Response Actual Parameters
Parameter | Data Type | Description | Sample Value |
|---|---|---|---|
contactid | String | A unique identifier generated by Five9 for each agent. | 300000001745182 |
connectionid | String | The unique ID for the call session generated by Five9. | 94EC5C196B8F4AF2B8213CEB2E3A02EF |
status | String | The name of any one of the events received from Five9. | offered, talking, finished |
startTimestamp | String | The call start time in ISO 8601 format. | 2024-03-21T08:55:20.512Z |
phoneNumber | String | A remote phone number as available in Five9. | 4084574613 |
type | String | The Interaction type. |
For more information, click Reference. |
Response Fields Parameters
Parameter | Data Type | Description | Sample Value |
|---|---|---|---|
fromAddress | String | Contact number associated with the communication. | 4084574613 |
CallState | String | The name of any one of the events received from Five9. | offered, talking, finished |
type | String | The type of call. | Inbound |
Sample Request
No sample requestSample Response
{
"channel": "Five9",
"topic": "inbound",
"subtopic": "InboundCallStateChange",
"message": {
"call": {
"ResponseActual": {
"contactId": "300000001745182",
"connectionId": "94EC5C196B8F4AF2B8213CEB2E3A02EF",
"status": "offered",
"startTimestamp": "2024-03-21T05:24:08.962Z",
"phoneNumber": "4084574613",
"type": "call"
},
"CallVariables": {
"first_name": "Jane",
"dob": "1990-01-01",
"last_name": "Doe"
},
"ResponseFields": {
"fromAddress": "4084574613",
"CallState": "offered",
"Type": "inbound"
},
"id": "94EC5C196B8F4AF2B8213CEB2E3A02EF",
"event": "offered",
"CallType": "inbound"
},
"source": "event"
}
}Note
In actual responses, there are some extra files that are either not in use or will be used in future release. Consider this during integration. The document mentions only the response variables that are currently in use.
Was this article helpful?