Skip to main content
Aria Knowledge Central

Version 2 vs. Version 3 of Billie Converse API and API Endpoints

Overview

You can use either Version 2 or Version 3 of the Billie Converse API. Below is a breakdown of use cases outlining why you might choose one versus the other.

Overview of Billie Converse API Versions 2 and 3

Aspect v2 (Synchronous) v3 (Asynchronous Webhook)

Use Cases

  • Real-time chat applications

  • Interactive customer service interfaces

  • When immediate response is required

  • Structured request/response supported

  • When response time flexibility is acceptable

  • Systems that can handle webhook callbacks

  • Structured request/response supported

Characteristics

  • Synchronous request-response

  • Immediate JSON response

  • Direct CSR handler processing

  • Built-in conversation management

  • Asynchronous processing via SQS

  • Webhook callback for response delivery

  • Task-based tracking with unique task IDs

  • Better scalability for high volumes

Response Time

  • Typical: 7- 15 seconds

  • Maximum: 30 seconds (API gateway timeout)

  • Immediate acknowledgment (202 status)

  • Actual response via webhook: 7+ seconds

Response Pattern

Immediate in HTTP response

Webhook callback to your endpoint

Integration Complexity

Simple - standard HTTP request/response

Moderate - requires webhook endpoint

Scalability

Limited by API gateway timeout (30s)

High - queue-based processing

Error Handling

Direct error response in HTTP body

Webhook delivery with error status

Best For

Interactive UI applications

Backend system integrations

Required Infrastructure

HTTP client only

HTTP client + webhook endpoint

Endpoints for Billie Connect Converse

This is a list of the Billie Connect Endpoints (aka api-gateway-domain) when calling the Converse API V2 or V3

POST https://{api-gateway-domain}/api/v2/converse
POST https://{api-gateway-domain}/api/v3/converse
Incoming Endpoint Region Stage
billieconnect.ariasystems.net US Production
billieconnect.current.stage.ariasystems.net US Stage Current
billieconnect.future.stage.ariasystems.net US Stage Future
billieconnect.aus.ariasystems.net AUS Production
billieconnect.current.stage.aus.ariasystems.net AUS Stage Current
billieconnect.future.stage.aus.ariasystems.net AUS Stage Future
billieconnect.sgp.ariasystems.net SGP Production
billieconnect.current.stage.sgp.ariasystems.net SGP Stage Current
billieconnect.future.stage.sgp.ariasystems.net SGP Stage Future
billieconnect.cph.ariasystems.net CPH Production
billieconnect.current.stage.cph.ariasystems.net CPH Stage Current
billieconnect.future.stage.cph.ariasystems.net CPH Stage Future
 
The following will be available with R71 rollout  
billieconnect.can.ariasystems.net CAN Production
billieconnect.current.stage.can.ariasystems.net CAN Stage Current
billieconnect.future.stage.can.ariasystems.net CAN Stage Future

TOP
  • Was this article helpful?