Skip to main content
POST
/
api
/
v1
/
create-web-call
Create web call
curl --request POST \
  --url https://voxworks.ai/api/v1/create-web-call \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "script_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "contact_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab"
}
'
{
  "success": true,
  "call_id": "<string>",
  "contact_id": "<string>",
  "status": "scheduled",
  "script_id": "<string>",
  "did": "<string>",
  "ws_url": "<string>",
  "sip_domain": "<string>",
  "sip_username": "<string>",
  "sip_password": "<string>",
  "target": "<string>",
  "headers": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.voxworks.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key from Voxworks, sent as Authorization: Bearer YOUR_API_KEY.

Body

application/json
​
script_id
string
required
​
contact_id
string
​
did
string

Optional SIP destination/user value. Defaults to web.

​
participant_identity
string
​
objects
object

Response

Web call created.

​
success
boolean
required
Example:

true

​
call_id
string
required
​
contact_id
string
required
​
status
string
required
Example:

"scheduled"

​
script_id
string
​
did
string | null
​
ws_url
string
​
sip_domain
string
​
sip_username
string
​
sip_password
string
​
target
string
​
headers
object