From 689025797f8ef1f55611dd9b7c6f73e7b25c1196 Mon Sep 17 00:00:00 2001 From: Pritom Roy <64958842+proy-bw@users.noreply.github.com> Date: Mon, 21 Aug 2023 12:50:44 +0100 Subject: [PATCH 1/3] Updated In-App guide --- site/global-guides/voice/inAppGuide.mdx | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/site/global-guides/voice/inAppGuide.mdx b/site/global-guides/voice/inAppGuide.mdx index c4e89ff5f..f51106084 100644 --- a/site/global-guides/voice/inAppGuide.mdx +++ b/site/global-guides/voice/inAppGuide.mdx @@ -161,9 +161,12 @@ The setServerConfig method takes 3 parameters that establish the relationship be There are three parameters for the setServerConfig method call: -1. serverAddresses: List of the Bandwidth WebRTC gateway FQDN -2. serverDomain: String containing the domain name to use in interactions with the WebRTC Gateway. This domain is a necessary portion of the endpoint addresses. -3. iceServers: List of the STUN and TURN servers, containing STUN:// or TURN:// IP addresses. This optional parameter is by default set as an empty list []. If it is used as an empty list, an external STUN server is not used during the creation of the call. This mode is useful when the client has direct visibility of the public network IP addresses of the Bandwidth WebRTC Gateway. +1. serverAddresses: ['wss://sbc.webrtc-app.bandwidth.com:10081'] + + List of the Bandwidth WebRTC gateway FQDN +2. serverDomain: 'sbc.webrtc-app.bandwidth.com' + + String containing the domain name to use in interactions with the WebRTC Gateway. This domain is a necessary portion of the endpoint addresses. +3. iceServers: ['stun.l.google.com:19302', 'stun1.l.google.com:19302','stun2.l.google.com:19302'] + + List of the STUN and TURN servers, containing STUN:// or TURN:// IP addresses. This optional parameter is by default set as an empty list []. If it is used as an empty list, an external STUN server is not used during the creation of the call. This mode is useful when the client has direct visibility of the public network IP addresses of the Bandwidth WebRTC Gateway. #### phone.setOAuthToken(token) @@ -226,10 +229,11 @@ Once the UA has been configured and the connection to the Bandwidth WebRTC Gatew The call method invoked on the UA instance will cause the configured and connected UA to launch a call towards the Bandwidth network. Yes - it is that simple. -The call method takes two parameters: +The call method takes three parameters: -1. The first parameter reflects the desired media, and as a result of the nature of the Bandwidth Voice network, this parameter must be supplied with the argument "phone.AUDIO" where the 'phone' represents the instance of the UA that has been created and configured. This parameter may be used in the future to extend the capabilities to other media. -2. The second parameter represents the destination telephone number for the outbound call. This TN should be a valid NANP telephone number. +1. callTo: The destination telephone number for the outbound call. This TN should be a valid E164 number. +2. extraHeaders: An array of strings, each representing a SIP header, to be added to the INVITE request. +3. extraOptions: The object can be used to set custom media streams for created calls. The call method returns an instance of a Session object, providing a handle that can be used for subsequent modification of the call while it is in progress. The methods applicable to the Session object instance will be discussed below. From 9aa3f128d5049b4b6466e630374b151bf98dd470 Mon Sep 17 00:00:00 2001 From: Pritom Roy <64958842+proy-bw@users.noreply.github.com> Date: Mon, 21 Aug 2023 13:58:06 +0100 Subject: [PATCH 2/3] Changed section title --- site/global-guides/voice/inAppGuide.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/global-guides/voice/inAppGuide.mdx b/site/global-guides/voice/inAppGuide.mdx index f51106084..ab0e299db 100644 --- a/site/global-guides/voice/inAppGuide.mdx +++ b/site/global-guides/voice/inAppGuide.mdx @@ -225,7 +225,7 @@ This method has two functions: Once the UA has been configured and the connection to the Bandwidth WebRTC Gateway has been established, it is time to make and manage calls. Once the setup is done, the rest is relatively straightforward. -#### activeCall = phone.call(phone.AUDIO, tn) +#### activeCall = phone.call(callTo, extraHeaders = null, extraOptions = null) The call method invoked on the UA instance will cause the configured and connected UA to launch a call towards the Bandwidth network. Yes - it is that simple. From 5dcae956c43d8765bdabddc32773d1b826ee5647 Mon Sep 17 00:00:00 2001 From: Pritom Roy <64958842+proy-bw@users.noreply.github.com> Date: Mon, 21 Aug 2023 18:04:55 +0100 Subject: [PATCH 3/3] Removing null in titles --- site/global-guides/voice/inAppGuide.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/site/global-guides/voice/inAppGuide.mdx b/site/global-guides/voice/inAppGuide.mdx index ab0e299db..a1a0b9ad9 100644 --- a/site/global-guides/voice/inAppGuide.mdx +++ b/site/global-guides/voice/inAppGuide.mdx @@ -155,7 +155,7 @@ Once all of the above initialization steps have been completed, the client is in The below methods on phone instances of the UA take care of readying the phone to make calls. -#### phone.setServerConfig(serverAddresses, serverDomain, iceServers); +#### phone.setServerConfig(serverAddresses, serverDomain, iceServers) The setServerConfig method takes 3 parameters that establish the relationship between the client and the network for making calls. This method should be called prior to any attempts to perform any other client or calling functions. @@ -225,7 +225,7 @@ This method has two functions: Once the UA has been configured and the connection to the Bandwidth WebRTC Gateway has been established, it is time to make and manage calls. Once the setup is done, the rest is relatively straightforward. -#### activeCall = phone.call(callTo, extraHeaders = null, extraOptions = null) +#### activeCall = phone.call(callTo, extraHeaders, extraOptions) The call method invoked on the UA instance will cause the configured and connected UA to launch a call towards the Bandwidth network. Yes - it is that simple.