Skip to content
This repository has been archived by the owner on Nov 29, 2023. It is now read-only.

Commit

Permalink
Merge remote-tracking branch 'origin/main' into bwdb-15583-new
Browse files Browse the repository at this point in the history
  • Loading branch information
@evanhalley
evanhalley committed Oct 27, 2023
2 parents 7e8a49d + c4602b5 commit 910e6db
Show file tree
Hide file tree
Showing 44 changed files with 3,662 additions and 989 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/listener.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ jobs:
- name: Open Pull Request
if: steps.replace-specs-snippets.outputs.needs_pr
run: |
hub pull-request --base Bandwidth:main $(if ${{ github.event.client_payload.draftPr }} ; then echo "-d" ; fi) -m '${{ github.event.client_payload.branchName }}' -m 'Update API specs from upstream api-specs repository. Opened By: @${{ github.event.client_payload.author }}'
gh pr create -B main $(if ${{ github.event.client_payload.draftPr }} ; then echo "-d" ; fi) -t '${{ github.event.client_payload.branchName }}' -b 'Update API specs from upstream api-specs repository. Opened By: @${{ github.event.client_payload.author }}'
env:
GITHUB_TOKEN: ${{ secrets.DX_GITHUB_TOKEN }}

Expand Down
92 changes: 46 additions & 46 deletions site/blogposts.config.json
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,57 @@
[
{
"categories": [
"CPaaS"
],
"categoryLinks": [
"https://www.bandwidth.com/blog/category/cpaas/"
],
"imageUrl": "https://www.bandwidth.com/wp-content/uploads/Blog_Cybersecurity-awareness-month.png",
"postLink": "https://www.bandwidth.com/blog/cybersecurity-awareness-month-2023/",
"postTitle": "Celebrating Cybersecurity Awareness Month 2023"
},
{
"categories": [
"Voice",
"Voice API"
],
"categoryLinks": [
"https://www.bandwidth.com/blog/category/voice/",
"https://www.bandwidth.com/blog/category/voice/voice-api/"
],
"imageUrl": "https://www.bandwidth.com/wp-content/uploads/Blog_Maestro_How-does-WebRTC-work_In-App-Calling.png",
"postLink": "https://www.bandwidth.com/blog/webrtc/",
"postTitle": "Your intro to In-App Calling, and the WebRTC tech it’s based on"
},
{
"categories": [
"Voice"
],
"categoryLinks": [
"https://www.bandwidth.com/blog/category/voice/"
],
"imageUrl": "https://www.bandwidth.com/wp-content/uploads/Blog_Evaluating-your-carrier_Picking-the-right-VoIP-provider.png",
"postLink": "https://www.bandwidth.com/blog/how-to-pick-the-right-provider/",
"postTitle": "Picking the right VoIP provider: 7 hacks from an industry insider"
},
{
"categories": [
"Voice"
],
"categoryLinks": [
"https://www.bandwidth.com/blog/category/voice/"
],
"imageUrl": "https://www.bandwidth.com/wp-content/uploads/Blog_Maestro_Fraud-scores-and-how-to-calculate-them.png",
"postLink": "https://www.bandwidth.com/blog/fraud-scores/",
"postTitle": "How to calculate fraud scores in your contact center"
},
{
"categories": [
"CPaaS",
"Direct Routing",
"Voice"
],
"categoryLinks": [
"https://www.bandwidth.com/blog/category/cpaas/",
"https://www.bandwidth.com/blog/category/direct-routing/",
"https://www.bandwidth.com/blog/category/voice/"
],
"imageUrl": "https://www.bandwidth.com/wp-content/uploads/Blog_Call-center-key-KPIs.png",
Expand Down Expand Up @@ -72,49 +116,5 @@
"imageUrl": "https://www.bandwidth.com/wp-content/uploads/Blog_Webex-Calling-Cloud-Connect-Local-Gateway.png",
"postLink": "https://www.bandwidth.com/blog/webex-calling-cloud-connect-vs-local-gateway/",
"postTitle": "Webex Calling: Cloud Connect vs. Local Gateway, Explained"
},
{
"categories": [
"CPaaS"
],
"categoryLinks": [
"https://www.bandwidth.com/blog/category/cpaas/"
],
"imageUrl": "https://www.bandwidth.com/wp-content/uploads/Blog_Maestro-Ai-Call-Centers.png",
"postLink": "https://www.bandwidth.com/blog/artificial-intelligence-for-call-centers-how-bots-are-saving-enterprise-cx/",
"postTitle": "Artificial intelligence for call centers: how bots are saving enterprise CX"
},
{
"categories": [
"CPaaS"
],
"categoryLinks": [
"https://www.bandwidth.com/blog/category/cpaas/"
],
"imageUrl": "https://www.bandwidth.com/wp-content/uploads/Blog_CiscoLive-Recap-1.png",
"postLink": "https://www.bandwidth.com/blog/ciscolive-2023-recap/",
"postTitle": "CiscoLive 2023: 5 highlights in communications"
},
{
"categories": [
"CPaaS"
],
"categoryLinks": [
"https://www.bandwidth.com/blog/category/cpaas/"
],
"imageUrl": "https://www.bandwidth.com/wp-content/uploads/Blog_Cloud-Migration.png",
"postLink": "https://www.bandwidth.com/blog/what-is-cloud-migration/",
"postTitle": "What is cloud migration? Cloud migration 101"
},
{
"categories": [
"CPaaS"
],
"categoryLinks": [
"https://www.bandwidth.com/blog/category/cpaas/"
],
"imageUrl": "https://www.bandwidth.com/wp-content/uploads/Blog_ECL-Teasers_Executives-ECL-Take.png",
"postLink": "https://www.bandwidth.com/blog/enterprise-communications-landscape-overview/",
"postTitle": "An executive’s take on 2023 Enterprise Communications"
}
]
3 changes: 2 additions & 1 deletion site/custom.config.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,6 @@
"dashSpecLink": "https://github.com/Bandwidth/api-docs/blob/main/site/specs/dash.json",
"dashNotificationsSpecLink": "https://github.com/Bandwidth/api-docs/blob/main/site/specs/dashNotifications.json",
"identitySpecLink": "https://github.com/Bandwidth/api-docs/blob/main/site/specs/one-identity-management.yml",
"insightsSpecLink": "https://github.com/Bandwidth/api-docs/blob/main/site/specs/insights.yml"
"insightsSpecLink": "https://github.com/Bandwidth/api-docs/blob/main/site/specs/insights.yml",
"emergencyProvisioningSpec": "https://github.com/Bandwidth/api-docs/blob/main/site/specs/emergency.yml"
}
48 changes: 25 additions & 23 deletions site/docs/voice/bxml/about.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export const Highlight = ({children, color}) => (

Bandwidth XML allows you to create a voice application as easily as you create a Web application. Using Bandwidth XML (or BXML) your application handles incoming call events using standard action verbs that are described in XML.

Before we begin creating a new BXML application you’ll need two things initially setup:
Before we begin creating a new BXML application you'll need two things initially setup:

1. A phone number that is allocated to your Bandwidth Application Platform account and is configured to an application. For instructions on setting up your application, read the [applications](/docs/account/applications/) page

Expand Down Expand Up @@ -59,28 +59,30 @@ If BXML execution ends without performing a webhook, there is an implicit `<Hang

| Verb | Description |
|:------------------------------------------------|:------------------------------------------------------------------------------------------------------|
| [`<Conference>`](/docs/voice/bxml/conference/) | The Conference verb is used to add a call to a conference. |
| [`<Bridge>`](/docs/voice/bxml/bridge/) | The Bridge verb is used to bridge two calls. |
| [`<Pause>`](/docs/voice/bxml/pause/) | The Pause verb is used to delay verb execution for a period of time. |
| [`<Forward>`](/docs/voice/bxml/forward/) | The Forward verb is used to forward an unanswered incoming call to another number. |
| [`<Transfer>`](/docs/voice/bxml/transfer/) | The Transfer verb is used to transfer the call to another number. |
| [`<Ring>`](/docs/voice/bxml/ring/) | The Ring verb is used to play ringing audio on a call. |
| [`<Hangup>`](/docs/voice/bxml/hangup/) | The Hangup verb is used to hang up or reject a call. |
| [`<Redirect>`](/docs/voice/bxml/redirect/) | The Redirect verb is used to redirect the current XML execution to another URL. |
| [`<PlayAudio>`](/docs/voice/bxml/playAudio/) | The PlayAudio verb is used to play an audio file in the call. |
| [`<SpeakSentence>`](/docs/voice/bxml/speakSentence/) | The SpeakSentence verb converts text into audible speech. |
| [`<Record>`](/docs/voice/bxml/record/) | The Record verb allows a segment of audio to be recorded during a call. |
| [`<StartRecording>`](/docs/voice/bxml/startRecording/) | The StartRecording verb allows a segment of a call to be recorded while other verbs are executing. |
| [`<PauseRecording>`](/docs/voice/bxml/pauseRecording/) | The PauseRecording verb is used to pause a recording previously started by a `<StartRecording>` verb. |
| [`<ResumeRecording>`](/docs/voice/bxml/resumeRecording/) | The ResumeRecording verb is used to resume a recording previously paused by a `<PauseRecording>` verb.|
| [`<StopRecording>`](/docs/voice/bxml/stopRecording/) | The StopRecording verb stops a recording that was previously started by a `<StartRecording>`. |
| [`<Gather>`](/docs/voice/bxml/gather/) | The Gather verb is used to collect DTMF digits. |
| [`<StartGather>`](/docs/voice/bxml/startGather/) | The StartGather verb is used to collect DTMF digits during the execution of other verbs. |
| [`<StopGather>`](/docs/voice/bxml/stopGather/) | The StopGather verb stops the DTMF collection initiated by `<StartGather>`. |
| [`<StartStream>`](/docs/voice/bxml/startStream/) | The StartStream verb allows a segment of a call to be streamed to an external destination. |
| [`<StopStream>`](/docs/voice/bxml/stopStream/) | The StopStream verb is used to stop a stream previously started by a `<StartStream>` verb. |
| [`<SendDtmf>`](/docs/voice/bxml/sendDtmf/) | The SendDtmf verb is used to play DTMF digits in the call. |
| [`<Tag>`](/docs/voice/bxml/tag/) | The Tag verb is used to set a new tag value without executing a webhook. |
| [`<Conference>`](/docs/voice/bxml/conference/) | The Conference verb is used to add a call to a conference. |
| [`<Bridge>`](/docs/voice/bxml/bridge/) | The Bridge verb is used to bridge two calls. |
| [`<Pause>`](/docs/voice/bxml/pause/) | The Pause verb is used to delay verb execution for a period of time. |
| [`<Forward>`](/docs/voice/bxml/forward/) | The Forward verb is used to forward an unanswered incoming call to another number. |
| [`<Transfer>`](/docs/voice/bxml/transfer/) | The Transfer verb is used to transfer the call to another number. |
| [`<Ring>`](/docs/voice/bxml/ring/) | The Ring verb is used to play ringing audio on a call. |
| [`<Hangup>`](/docs/voice/bxml/hangup/) | The Hangup verb is used to hang up or reject a call. |
| [`<Redirect>`](/docs/voice/bxml/redirect/) | The Redirect verb is used to redirect the current XML execution to another URL. |
| [`<PlayAudio>`](/docs/voice/bxml/playAudio/) | The PlayAudio verb is used to play an audio file in the call. |
| [`<SpeakSentence>`](/docs/voice/bxml/speakSentence/) | The SpeakSentence verb converts text into audible speech. |
| [`<Record>`](/docs/voice/bxml/record/) | The Record verb allows a segment of audio to be recorded during a call. |
| [`<StartRecording>`](/docs/voice/bxml/startRecording/) | The StartRecording verb allows a segment of a call to be recorded while other verbs are executing. |
| [`<PauseRecording>`](/docs/voice/bxml/pauseRecording/) | The PauseRecording verb is used to pause a recording previously started by a `<StartRecording>` verb. |
| [`<ResumeRecording>`](/docs/voice/bxml/resumeRecording/) | The ResumeRecording verb is used to resume a recording previously paused by a `<PauseRecording>` verb. |
| [`<StopRecording>`](/docs/voice/bxml/stopRecording/) | The StopRecording verb stops a recording that was previously started by a `<StartRecording>`. |
| [`<Gather>`](/docs/voice/bxml/gather/) | The Gather verb is used to collect DTMF digits. |
| [`<StartGather>`](/docs/voice/bxml/startGather/) | The StartGather verb is used to collect DTMF digits during the execution of other verbs. |
| [`<StopGather>`](/docs/voice/bxml/stopGather/) | The StopGather verb stops the DTMF collection initiated by `<StartGather>`. |
| [`<StartStream>`](/docs/voice/bxml/startStream/) | The StartStream verb allows a segment of a call to be streamed to an external destination. |
| [`<StopStream>`](/docs/voice/bxml/stopStream/) | The StopStream verb is used to stop a stream previously started by a `<StartStream>` verb. |
| [`<StartTranscription>`](/docs/voice/bxml/startTranscription/) | The StartTranscription verb allows a segment of a call to be transcribed during the execution of other verbs. |
| [`<StopTranscription>`](/docs/voice/bxml/stopTranscription/) | The StopTranscription verb is used to stop a transcription previously started by a `<StartTranscription>` verb. |
| [`<SendDtmf>`](/docs/voice/bxml/sendDtmf/) | The SendDtmf verb is used to play DTMF digits in the call. |
| [`<Tag>`](/docs/voice/bxml/tag/) | The Tag verb is used to set a new tag value without executing a webhook. |

### BXML Webhooks

Expand Down
35 changes: 10 additions & 25 deletions site/docs/voice/bxml/bridge.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -196,38 +196,23 @@ Console.WriteLine(response.ToBXML());

First call (c-95ac8d6e-1a31c52e-b38f-4198-93c1-51633ec68f8d):
```ruby
speak_sentence = Bandwidth::Voice::SpeakSentence.new({
:sentence => "Wait until the second call answers."
})

pause = Bandwidth::Voice::Pause.new({
:duration => 60
})

response = Bandwidth::Voice::Response.new()
response.push(speak_sentence)
response.push(pause)
speak_sentence = Bandwidth::Bxml::SpeakSentence.new('Wait until the second call answers.')
pause = Bandwidth::Bxml::Pause.new({ duration: 60 })
response = Bandwidth::Bxml::Response.new([speak_sentence, pause])

puts response.to_bxml()
p response.to_bxml
```

Second call:
```ruby
speak_sentence = Bandwidth::Voice::SpeakSentence.new({
:sentence => "The bridge will start now."
speak_sentence = Bandwidth::Bxml::SpeakSentence.new('The bridge will start now.')
bridge = Bandwidth::Bxml::Bridge.new('c-95ac8d6e-1a31c52e-b38f-4198-93c1-51633ec68f8d', {
bridge_complete_url: 'https://bridge.url/nextBXMLForSecondCall',
bridge_target_complete_url: 'https://bridge.url/nextBXMLForFirstCall'
})
response = Bandwidth::Bxml::Response.new([speak_sentence, bridge])

bridge = Bandwidth::Voice::Bridge.new({
:call_id => "c-c-95ac8d6e-1a31c52e-b38f-4198-93c1-51633ec68f8d",
:bridge_complete_url => "https://bridge.url/nextBXMLForSecondCall",
:bridge_target_complete_url => "https://bridge.url/nextBXMLForFirstCall"
})

response = Bandwidth::Voice::Response.new()
response.push(speak_sentence)
response.push(bridge)

puts response.to_bxml()
p response.to_bxml
```

</TabItem>
Expand Down
36 changes: 10 additions & 26 deletions site/docs/voice/bxml/conference.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -147,20 +147,11 @@ Console.WriteLine(response.ToBXML());
<TabItem value="ruby">

```ruby
speak_sentence = Bandwidth::Voice::SpeakSentence.new({
:sentence => "You will be added to your conference now.",
:gender => "male"
})

conference = Bandwidth::Voice::Conference.new({
:conference_name => 'my-conference-name'
})
speak_sentence = Bandwidth::Bxml::SpeakSentence.new('You will be added to your conference now.', { gender: 'male' })
conference = Bandwidth::Bxml::Conference.new('my-conference-name')
response = Bandwidth::Bxml::Response.new([speak_sentence, conference])

response = Bandwidth::Voice::Response.new()
response.push(speak_sentence)
response.push(conference)

puts response.to_bxml()
p response.to_bxml
```

</TabItem>
Expand Down Expand Up @@ -292,22 +283,15 @@ response.Add(conference);
<TabItem value="ruby">

```ruby
speak_sentence = Bandwidth::Voice::SpeakSentence.new({
:sentence => "Welcome. You are going to coach 2 calls, please wait.",
:gender => "male"
speak_sentence = Bandwidth::Bxml::SpeakSentence.new('Welcome. You are going to coach 2 calls, please wait.', {
gender: 'male'
})
conference = Bandwidth::Voice::Conference.new({
:conference_name => 'my-conference-name',
:call_ids_to_coach => "c-95ac8d6e-1a31c52e-b38f-4198-93c1-51633ec68f8d,c-2a913f94-6a486f3a-3cae-4034-bcc3-f0c9fa77ca2f",
#or
:call_ids_to_coach => ["c-95ac8d6e-1a31c52e-b38f-4198-93c1-51633ec68f8d", "c-2a913f94-6a486f3a-3cae-4034-bcc3-f0c9fa77ca2f"]
conference = Bandwidth::Bxml::Conference.new('my-conference-name', {
call_ids_to_coach: ['c-95ac8d6e-1a31c52e-b38f-4198-93c1-51633ec68f8d', 'c-2a913f94-6a486f3a-3cae-4034-bcc3-f0c9fa77ca2f']
})
response = Bandwidth::Bxml::Response.new([speak_sentence, conference])

response = Bandwidth::Voice::Response.new()
response.push(speak_sentence)
response.push(conference)

puts response.to_bxml()
p response.to_bxml
```

</TabItem>
Expand Down
12 changes: 5 additions & 7 deletions site/docs/voice/bxml/forward.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,15 +97,13 @@ Console.WriteLine(response.ToBXML());
<TabItem value="ruby">

```ruby
forward = Bandwidth::Voice::Forward.new({
:to => "+10987654321",
:from => "+11234567890"
forward = Bandwidth::Bxml::Forward.new({
to: '+10987654321',
from: '+11234567890'
})
response = Bandwidth::Bxml::Response.new([forward])

response = Bandwidth::Voice::Response.new()
response.push(forward)

puts response.to_bxml()
p response.to_bxml
```

</TabItem>
Expand Down
Loading

0 comments on commit 910e6db

Please sign in to comment.