Skip to content

Commit 84ed3e1

Browse files
ateleguatelegu
committed
VAPI-3163
1 parent ca77566 commit 84ed3e1

6 files changed

Lines changed: 442 additions & 0 deletions

File tree

‎.openapi-generator/FILES‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,7 @@ docs/RecordingTranscriptions.md
168168
docs/RecordingsApi.md
169169
docs/RedirectCallback.md
170170
docs/RedirectMethodEnum.md
171+
docs/ReferCompleteCallback.md
171172
docs/SipConnectionMetadata.md
172173
docs/SipCredentials.md
173174
docs/SmsMessageContent.md
@@ -403,6 +404,7 @@ src/Bandwidth.Standard/Model/RecordingTranscriptionMetadata.cs
403404
src/Bandwidth.Standard/Model/RecordingTranscriptions.cs
404405
src/Bandwidth.Standard/Model/RedirectCallback.cs
405406
src/Bandwidth.Standard/Model/RedirectMethodEnum.cs
407+
src/Bandwidth.Standard/Model/ReferCompleteCallback.cs
406408
src/Bandwidth.Standard/Model/SipConnectionMetadata.cs
407409
src/Bandwidth.Standard/Model/SipCredentials.cs
408410
src/Bandwidth.Standard/Model/SmsMessageContent.cs

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -328,6 +328,7 @@ Class | Method | HTTP request | Description
328328
- [Model.RecordingTranscriptions](docs/RecordingTranscriptions.md)
329329
- [Model.RedirectCallback](docs/RedirectCallback.md)
330330
- [Model.RedirectMethodEnum](docs/RedirectMethodEnum.md)
331+
- [Model.ReferCompleteCallback](docs/ReferCompleteCallback.md)
331332
- [Model.SipConnectionMetadata](docs/SipConnectionMetadata.md)
332333
- [Model.SipCredentials](docs/SipCredentials.md)
333334
- [Model.SmsMessageContent](docs/SmsMessageContent.md)

‎api/openapi.yaml‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13398,6 +13398,105 @@ components:
1339813398
example: "+15555555555"
1339913399
type: string
1340013400
type: object
13401+
referCompleteCallback:
13402+
description: "The Refer Complete event is fired when the <Refer> verb finishes\
13403+
\ executing. This is sent to the referCompleteUrl specified on the <Refer>\
13404+
\ verb, and the BXML returned in it is executed on the call."
13405+
properties:
13406+
eventType:
13407+
description: "The event type, value can be one of the following: answer,\
13408+
\ bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect,\
13409+
\ conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable,\
13410+
\ disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete,\
13411+
\ recordingAvailable, redirect, transcriptionAvailable, transferAnswer,\
13412+
\ transferComplete, transferDisconnect."
13413+
example: bridgeComplete
13414+
type: string
13415+
eventTime:
13416+
description: "The approximate UTC date and time when the event was generated\
13417+
\ by the Bandwidth server, in ISO 8601 format. This may not be exactly\
13418+
\ the time of event execution."
13419+
example: 2022-06-17T22:19:40.375Z
13420+
format: date-time
13421+
type: string
13422+
accountId:
13423+
description: The user account associated with the call.
13424+
example: "9900000"
13425+
type: string
13426+
applicationId:
13427+
description: The id of the application associated with the call.
13428+
example: 04e88489-df02-4e34-a0ee-27a91849555f
13429+
type: string
13430+
from:
13431+
description: The provided identifier of the caller. Must be a phone number
13432+
in E.164 format (e.g. +15555555555).
13433+
example: "+15555555555"
13434+
type: string
13435+
to:
13436+
description: "The phone number that received the call, in E.164 format (e.g.\
13437+
\ +15555555555)."
13438+
example: "+15555555555"
13439+
type: string
13440+
direction:
13441+
$ref: '#/components/schemas/callDirectionEnum'
13442+
callId:
13443+
description: The call id associated with the event.
13444+
example: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
13445+
type: string
13446+
callUrl:
13447+
description: The URL of the call associated with the event.
13448+
example: https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
13449+
format: uri
13450+
type: string
13451+
enqueuedTime:
13452+
description: "(optional) If call queueing is enabled and this is an outbound\
13453+
\ call, time the call was queued, in ISO 8601 format."
13454+
example: 2022-06-17T22:20:00Z
13455+
format: date-time
13456+
nullable: true
13457+
type: string
13458+
startTime:
13459+
description: "Time the call was started, in ISO 8601 format."
13460+
example: 2022-06-17T22:19:40.375Z
13461+
format: date-time
13462+
type: string
13463+
answerTime:
13464+
description: "Time the call was answered, in ISO 8601 format."
13465+
example: 2022-06-17T22:20:00Z
13466+
format: date-time
13467+
nullable: true
13468+
type: string
13469+
tag:
13470+
description: "(optional) The tag specified on call creation. If no tag was\
13471+
\ specified or it was previously cleared, this field will not be present."
13472+
example: exampleTag
13473+
nullable: true
13474+
type: string
13475+
sipResponseCode:
13476+
description: "The SIP response code from the REFER request, indicating the\
13477+
\ outcome of the operation (e.g., 200 for success, 404 for not found)."
13478+
example: 200
13479+
nullable: true
13480+
type: integer
13481+
cause:
13482+
description: "Reason the call failed - hangup, busy, timeout, cancel, rejected,\
13483+
\ callback-error, invalid-bxml, application-error, account-limit, node-capacity-exceeded,\
13484+
\ error, or unknown."
13485+
example: busy
13486+
type: string
13487+
errorMessage:
13488+
description: Text explaining the reason that caused the call to fail in
13489+
case of errors.
13490+
example: Call c-2a913f94-6a486f3a-3cae-4034-bcc3-f0c9fa77ca2f is already
13491+
bridged with another call
13492+
nullable: true
13493+
type: string
13494+
errorId:
13495+
description: Bandwidth's internal id that references the error event.
13496+
example: 4642074b-7b58-478b-96e4-3a60955c6765
13497+
nullable: true
13498+
type: string
13499+
type: object
1340113500
transcriptionAvailableCallback:
1340213501
description: The Transcription Available event is sent when the recording transcription
1340313502
is available to be downloaded.
@@ -13981,6 +14080,12 @@ components:
1398114080
example: 4642074b-7b58-478b-96e4-3a60955c6765
1398214081
nullable: true
1398314082
type: string
14083+
sipResponseCode:
14084+
description: "The SIP response code from the REFER request, indicating the outcome\
14085+
\ of the operation (e.g., 200 for success, 404 for not found)."
14086+
example: 200
14087+
nullable: true
14088+
type: integer
1398414089
machineDetectionResult:
1398514090
description: "(optional) if machine detection was requested in sync mode, the\
1398614091
\ result will be specified here. Possible values are the same as the async\

‎bandwidth.yml‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5034,6 +5034,47 @@ components:
50345034
$ref: '#/components/schemas/transferCallerId'
50355035
transferTo:
50365036
$ref: '#/components/schemas/transferTo'
5037+
referCompleteCallback:
5038+
type: object
5039+
description: >-
5040+
The Refer Complete event is fired when the <Refer> verb finishes
5041+
executing. This is sent to the referCompleteUrl specified on the
5042+
<Refer> verb, and the BXML returned in it is executed on the call.
5043+
properties:
5044+
eventType:
5045+
$ref: '#/components/schemas/eventType'
5046+
eventTime:
5047+
$ref: '#/components/schemas/eventTime'
5048+
accountId:
5049+
$ref: '#/components/schemas/accountId'
5050+
applicationId:
5051+
$ref: '#/components/schemas/applicationId1'
5052+
from:
5053+
$ref: '#/components/schemas/from'
5054+
to:
5055+
$ref: '#/components/schemas/to'
5056+
direction:
5057+
$ref: '#/components/schemas/callDirectionEnum'
5058+
callId:
5059+
$ref: '#/components/schemas/callId'
5060+
callUrl:
5061+
$ref: '#/components/schemas/callUrl'
5062+
enqueuedTime:
5063+
$ref: '#/components/schemas/enqueuedTime'
5064+
startTime:
5065+
$ref: '#/components/schemas/startTime'
5066+
answerTime:
5067+
$ref: '#/components/schemas/answerTime'
5068+
tag:
5069+
$ref: '#/components/schemas/tag1'
5070+
sipResponseCode:
5071+
$ref: '#/components/schemas/sipResponseCode'
5072+
cause:
5073+
$ref: '#/components/schemas/cause'
5074+
errorMessage:
5075+
$ref: '#/components/schemas/errorMessage'
5076+
errorId:
5077+
$ref: '#/components/schemas/errorId'
50375078
transcriptionAvailableCallback:
50385079
type: object
50395080
description: >-
@@ -5400,6 +5441,13 @@ components:
54005441
description: Bandwidth's internal id that references the error event.
54015442
example: 4642074b-7b58-478b-96e4-3a60955c6765
54025443
nullable: true
5444+
sipResponseCode:
5445+
type: integer
5446+
description: >-
5447+
The SIP response code from the REFER request, indicating the outcome
5448+
of the operation (e.g., 200 for success, 404 for not found).
5449+
example: 200
5450+
nullable: true
54035451
machineDetectionResult:
54045452
type: object
54055453
description: >-

‎docs/ReferCompleteCallback.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Bandwidth.Standard.Model.ReferCompleteCallback
2+
The Refer Complete event is fired when the <Refer> verb finishes executing. This is sent to the referCompleteUrl specified on the <Refer> verb, and the BXML returned in it is executed on the call.
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**EventType** | **string** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional]
9+
**EventTime** | **DateTime** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional]
10+
**AccountId** | **string** | The user account associated with the call. | [optional]
11+
**ApplicationId** | **string** | The id of the application associated with the call. | [optional]
12+
**From** | **string** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional]
13+
**To** | **string** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional]
14+
**Direction** | **CallDirectionEnum** | | [optional]
15+
**CallId** | **string** | The call id associated with the event. | [optional]
16+
**CallUrl** | **string** | The URL of the call associated with the event. | [optional]
17+
**EnqueuedTime** | **DateTime?** | (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format. | [optional]
18+
**StartTime** | **DateTime** | Time the call was started, in ISO 8601 format. | [optional]
19+
**AnswerTime** | **DateTime?** | Time the call was answered, in ISO 8601 format. | [optional]
20+
**Tag** | **string** | (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. | [optional]
21+
**SipResponseCode** | **int?** | The SIP response code from the REFER request, indicating the outcome of the operation (e.g., 200 for success, 404 for not found). | [optional]
22+
**Cause** | **string** | Reason the call failed - hangup, busy, timeout, cancel, rejected, callback-error, invalid-bxml, application-error, account-limit, node-capacity-exceeded, error, or unknown. | [optional]
23+
**ErrorMessage** | **string** | Text explaining the reason that caused the call to fail in case of errors. | [optional]
24+
**ErrorId** | **string** | Bandwidth&#39;s internal id that references the error event. | [optional]
25+
26+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
27+

0 commit comments

Comments
 (0)