Skip to main content
POST
Create Virtual Receptionist

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
tenantId
number
required
name
string
required
Minimum string length: 1
timeout
number
default:10
Required range: x <= 20
loopOnTimeout
string
default:""
Maximum string length: 5
loopOnWrongKeyPress
string
default:""
Maximum string length: 5
allowExtensionDialing
string
default:""
Maximum string length: 5
allowFeatures
string
default:""
Maximum string length: 5
digitTimeout
number
default:2
allowCustom
string
default:""
Maximum string length: 5
maxLoops
number
default:5
Required range: x <= 5
loopPlayMessageOnce
string
default:""
Maximum string length: 5
enableSpeechDetect
number
default:0
branchId
number
keyPressDestinations
object[]
greetingDestinations
object[]
timeoutDestinations
object[]
announcementsIds
number[]

Response

200 - application/json

Created virtual receptionist

id
number
required
tenantId
number | null
required
name
string | null
required
timeout
number | null
required
loopOnTimeout
string | null
required
loopOnWrongKeyPress
string | null
required
loopPlayMessageOnce
string | null
required
allowExtensionDialing
string | null
required
maxLoops
number | null
required
enableSpeechDetect
number | null
required
branch
object
required

Resolved branch

announcements
object[]
greetingDestinations
object[]
keyPressDestinations
object[]
timeoutDestinations
object[]
{key}
any