Skip to content

REST API v2

Jerry Hu edited this page Sep 29, 2025 · 3 revisions

v1 API remain the same until further notice.

Changes from v1

HTTP Method follows RESTful API

GET, POST, PUT and DELETE

Authentication is no longer in the body

The Custom HTTP Authentication Header for auth_token

Authorization: AuthToken <session-auth-token>

API Versioning

The API endpoint paths start with /enterprise_api/v2/...

Conversation API

Allows importing a conversation following the VCON (version 0.0.2). Currently only audio recording is supported.

The conversation will be converted to a "meeting" and the recording imported and transcribed.

  • The party with "role": "host" will be treated as the account owner.
  • The inbound call direction can be set using "dialog": [ { ... "meta": { "direction": "in" } ... } ]

Request & response

curl -s \
  -H "Content-Type: application/vcon" \
  -H "Authorization: AuthToken ${TOKEN}" \
  -d @test.vcon \
  "https://${DOMAIN}/enterprise_api/v2/conversation/import/${HOST_ID}/vcon"

# success response
< HTTP/2 202
< content-type: application/json; charset=utf-8
{"uuid":"..."}

# error response (invalid auth)
< HTTP/2 401

# error response (invalid vcon)
< HTTP/2 400 
< content-type: application/json
{"error":"Invalid vCon: parties required."}

Webhook

  • vcon_import_success is sent when the import successfully completes.
    • example payload (JSON encoded string): {"uuid":"...", "conference_id":..., "company_id":..., "host_id":...}
  • vcon_import_failure is sent when the import fails.
    • example payload (JSON encoded string) when the recording link returns 403: {"uuid":"...", "company_id":.., "host_id":..., "error":"403 Forbidden"}
Clone this wiki locally