state field containing all conversation variables (conv.state values) set during the call — both built-in keys and custom variables your agent writes.
For technical details and API specifications, refer to the Get Conversation API documentation.
Push and pull
PolyAI supports both push and pull API models, offering flexible synchronization options:- Pull API: On-demand metadata retrieval through the List Conversations endpoint. Ideal for periodic data collection or workflows where updates are less time-sensitive.
- Push API: Automatically sends updates (new conversations or completed interactions) to your system in real time. Best suited for dashboards requiring prompt updates.
For triggering instant communication updates for real-time use cases, like determining where to route a call, it
is recommended to use handoff states.
Best practices
- Pull: Use this model for scheduled reporting or when real-time updates are unnecessary.
- Push: Use push updates for real-time synchronization, such as live agent dashboards.
- If you need real-time updates, use push. If periodic batch retrieval is sufficient, use pull.
Integration with other workflows
The List Conversations API can fit into a larger data-sharing workflow:- Manual access using the studio: View richly-detailed conversation transcripts and recordings directly in the PolyAI platform.
- End of call metadata retrieval: Automate metadata syncing after conversations using push or pull APIs.
- Handoff metadata integration: Provide your live customer agent with a quick identifier indicating what kind of call they have just received.