Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DC-365 #462

Merged
merged 1 commit into from
Mar 31, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/telephony/code-snippets/connect-to-pstn.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,15 @@ import TabItem from '@theme/TabItem';

The following code example shows how you can connect the Telephony API to your cell phone or any other type of phone number using PSTN (**Currently, only US phone numbers work**). Making a phone call is also the quickest way to test Symbl’s Telephony API. It can make an outbound call to a phone number using a traditional public switched telephony network ([PSTN](https://en.wikipedia.org/wiki/Public_switched_telephone_network)).

#### <a name="code-example-1"></a>Code Example

:::info
The <strong>Symbl SDK (Node.js)</strong> snippet must be run using Node.js, while the <strong>Native Javascript</strong> snippet can be run in your web browser.
:::

### Authentication
Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.

#### <a name="code-example-1"></a>Code Example

<Tabs
defaultValue="cURL"
values={[
Expand Down
8 changes: 5 additions & 3 deletions docs/telephony/code-snippets/connect-to-sip.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,15 @@ import TabItem from '@theme/TabItem';

The following code sample shows how you can connect the Telephony API to your cell phone (or any other type of phone number). Making a phone call is also the quickest way to test Symbl’s Telephony API. It can make an outbound call to a phone number using SIP endpoints that can be accessed over the internet using a SIP URI.


#### <a name="code-example-1"></a>Code Example

:::info
The <strong>Symbl SDK (Node.js)</strong> snippet must be run using Node.js, while the <strong>Native Javascript</strong> snippet can be run in your web browser.
:::

### Authentication
Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.

#### <a name="code-example-1"></a>Code Example

<Tabs
defaultValue="cURL"
values={[
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,16 @@ When we're connecting to the Web Socket, we can define which language we use in
}
```

#### <a name="code-example-1"></a>Full Code Example

:::info
The <strong>Symbl SDK (Node.js)</strong> snippet must be run using Node.js, while the <strong>Native Javascript</strong> snippet can be run in your web browser.
:::

### Authentication
Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.

#### <a name="code-example-1"></a>Full Code Example

<Tabs
defaultValue="cURL"
values={[
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,12 +57,16 @@ Here you set the language key to Japanese: `"languages": ["ja-JP"],` and the tim
}
```

### <a name="code-example-1"></a>Full Code Example

:::info
The <strong>Symbl SDK (Node.js)</strong> snippet must be run using Node.js, while the <strong>Native Javascript</strong> snippet can be run in your web browser.
:::

### Authentication
Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.

### <a name="code-example-1"></a>Full Code Example

<Tabs
defaultValue="cURL"
values={[
Expand Down
3 changes: 2 additions & 1 deletion docs/telephony/reference/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ import TabItem from '@theme/TabItem';

---

## Endpoint
### Authentication
Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.

### HTTP REQUEST

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@ From the root directory of your project, run the following command to add `@symb
```bash
npm i --save @symblai/symbl-js
```
### Authentication
Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.

### Retrieve your Symbl API credentials

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,13 +44,14 @@ From the root directory of your project, run the following command to add `symbl
```bash
$ npm i --save symbl-node
```
### Authentication
Before using this API, you must generate your authentication token (`AUTH_TOKEN`). To learn how to get the authentication token, see the [Authentication](/docs/developer-tools/authentication) page.

### <a name="retrieve-credentials"></a>Retrieve your credentials

Your credentials include your appId and appSecret. You can find them on the home page of the platform.
![credentials page](/img/credentials.png)


### <a name="init-sdk"></a>Initialize SDK

Create a new file named index.js in your project and add the following lines to initialize the Symbl SDK:
Expand Down