ben.carrasco/jambonz-api-server
1
0
Fork 0
mirror of https://github.com/jambonz/jambonz-api-server.git synced 2026-01-25 02:08:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

update swagger docs (#157)

Browse Source
This commit is contained in:
Anton Voylenko
2023-05-01 17:50:22 +03:00
committed by GitHub
parent c97874ed1f
commit 3997f57365
1 changed files with 30 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
lib/swagger/swagger.yaml
View File

@@ -3743,8 +3743,13 @@ paths:
type: string
format: uuid
description: The application to use to control this call. Either applicationSid or url is required.
answerOnBridge:
type: boolean
description: If set to true, the inbound call will ring until the number that was dialed answers the call, and at that point a 200 OK will be sent on the inbound leg. If false, the inbound call will be answered immediately as the outbound call is placed.
example: false
call_hook:
$ref: '#/components/schemas/Webhook'
example: {"url": "https://acme.com/callhook", "method": "POST"}
call_status_hook:
$ref: '#/components/schemas/Webhook'
example: {"url": "https://acme.com/status", "method": "POST"}
@@ -3758,15 +3763,23 @@ paths:
example: "blf.finotel.com"
timeout:
type: integer
description: the number of seconds to wait for call to be answered. Defaults to 60.
description: The number of seconds to wait for call to be answered. Defaults to 60.
example: 30
timeLimit:
type: integer
description: The max length of call in seconds
example: 60
tag:
type: object
description: initial set of customer-supplied metadata to associate with the call (see jambonz 'tag' verb)
description: Initial set of customer-supplied metadata to associate with the call (see jambonz 'tag' verb)
example: {"callCount": 10}
to:
$ref: '#/components/schemas/Target'
description: destination for call
description: Destination for call
headers:
type: object
description: The customer SIP headers to associate with the call
example: {"X-Custom-Header": "Hello"}
responses:
201:
description: call successfully created
@@ -3916,6 +3929,8 @@ paths:
properties:
call_hook:
$ref: '#/components/schemas/Webhook'
child_call_hook:
$ref: '#/components/schemas/Webhook'
call_status:
type: string
enum:
@@ -3935,6 +3950,7 @@ paths:
type: string
enum:
- pause
- silence
- resume
mute_status:
type: string
@@ -4486,10 +4502,21 @@ components:
- phone
- sip
- user
- teams
number:
type: string
sipUri:
type: string
tenant:
type: string
description: Microsoft Teams customer tenant domain name
trunk:
type: string
vmail:
type: boolean
description: Dial directly into user's voicemail to leave a message
overrideTo:
type: string
name:
type: string
auth: