Conversation Events

Every conversation event type has the following properties:

Property Type Description
Required Properties
conversation_id string ID of the conversation associated with the conference.
event_type string The type of Conversation Event stored in the event field
Optional Properties
conference_name string If the conversation was the result of a conference, the name of the conference. Otherwise, not present.

Conversation Ended Event

Sent when a conversation ends. For conference calls, this is as soon as the last person disconnects from the conference. For direct calls, this is when either party hangs up.

Event type:ended
Property Type Description
start_time string Start date and time of the conversation, as an ISO 8601 string.
end_time string End date and time of the conversation, as an ISO 8601 string.
status string Status of the conversation. One of the Conversation status strings

Example

{
    "conversation_id": "5d3dc73fc8cf34be",
    "event_type": "ended",
    "start_time": 2016-05-06T19:22:22Z,
    "end_time": 2016-05-06T19:45:21Z,
    "status": "processing"
}

Transcript Event

Sent when a segment of audio is transcribed.

Event type:transcript
Event structure:
 
Property Type Description
timestamp_ms integer The start time of the segment, in milliseconds since the epoch.
duration_ms integer Duration of the segment, in milliseconds.
connection_id string The ID of the connection within the conversation that was speaking.
transcript string Machine-generated transcript of the segment, as text.

Example

{
    "conversation_id": "5d3dc73fc8cf34be",
    "conference_name": "party-room",
    "event_type": "transcript",
    "transcript": "yes i would love to subscribe to some magazines",
    "connection_id": "3143d63913ff344c",
    "timestamp_ms": 1462514977421,
    "duration_ms": 10430
}

Talk Time Event

Sent repeatedly during a conversation when the amount of time spent speaking changes.

Event type:talk-time
Event structure:
 
Property Type Description
talk_times dictionary The time that each connection has spent talking. The keys are ids of connections participanting in the conversation, as strings. Each key references an integer representing the number of milliseconds that the connection has spent speaking in the conversation.

Example

{
    "conversation_id": "5d3dc73fc8cf34be",
    "conference_name": "party-room",
    "event_type": "talk-time",
    "talk_times": {
        "3143d63913ff344c": 5128,
        "6cc621614fc279b0": 90282
    }
}

Topic Event

Sent when new conversation topics are detected.

Event type:topics
Event structure:
 
Property Type Description
topics list[string] List of the most recent topics of the conversation.

Example

{
    "conversation_id": "5d3dc73fc8cf34be",
    "event_type": "topics",
    "topics": ["vacation", "grand canyon", "weather"]
}

Done Processing Event

Sent when all Conversation Processors bound to a conversation have finished.

Event name:done-processing
Event structure:
 The body is a Conversation object.