Dec 10 --> Mar 5 2025 update

.github/workflows/preview-docs.yml

@@ -17,6 +17,7 @@ jobs:
         id: generate-docs
         env:
           FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
+          POSTHOG_PROJECT_API_KEY: ${{ secrets.POSTHOG_PROJECT_API_KEY }}
         run: |
           OUTPUT=$(fern generate --docs --preview --log-level debug 2>&1) || true
           echo "$OUTPUT"

.github/workflows/publish-docs.yml

@@ -19,4 +19,5 @@ jobs:
       - name: Publish Docs
         env:
           FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
+          POSTHOG_PROJECT_API_KEY: ${{ secrets.POSTHOG_PROJECT_API_KEY }}
         run: fern generate --docs --log-level debug

fern/GHL.mdx

@@ -1,6 +1,6 @@
 ---
 title: How to Connect Vapi with Make & GHL
-slug: GHL
+slug: tools/GHL
 ---
 
 

fern/advanced/sip/sip-telnyx.mdx

@@ -0,0 +1,167 @@
+---
+title: Telnyx SIP Integration
+subtitle: How to integrate SIP Telnyx to Vapi
+slug: advanced/sip/telnyx
+---
+## Inbound
+### On Vapi
+<Steps>
+<Step title="Personalized origination SIP URI creation">
+
+First we will create a personalized origination SIP URI via the Vapi API 
+
+```json
+curl --location 'https://api.vapi.ai/phone-number' \
+	--header 'Authorization: Bearer your-vapi-private-api-key' \
+	--header 'Content-Type: application/json' \
+	--data-raw '{
+		"provider": "vapi",
+		"sipUri": "sip:[email protected]",
+		"assistantId": "your-assistant-id"
+	}'
+```
+ - ```provider```: This is set to "vapi".
+ - ```sipUri```: Replace ` username ` with your desired SIP username.
+ - ```assistantId```: Provide your specific `assistant ID` associated with your Vapi AI account.
+</Step>
+
+<Step title="[Optional] Send call request to a webhook instead of assistant">
+
+Send a PATCH to /phone-number/your_phone_id
+
+```json
+ curl --location --request PATCH 'https://api.vapi.ai/phone-number/your_phone_id' \
+ 	--header 'Content-Type: application/json' \
+ 	--header 'Authorization: Bearer your-vapi-private-api-key' \
+ 	--data '{
+ 		"assistantId": null,
+ 		"serverUrl": "https://your_server_url"
+ 	}'
+```
+- `your_server_url` is the webhook link that will receive the assistant request.
+- `your_phone_id` is the id of your just created origination sip URI
+
+Now every time you make a call to this number (i.e. assigned numbers on SIP trunking to this origination URI), you'll get a webhook event requesting an assistant.
+</Step>
+</Steps>
+
+### On Telnyx
+<Steps>
+<Step title="Setup inbound authentication">
+1. Go to Voice / SIP Trunking / Create
+2. Select FQDN
+3. Select add FQDN
+4. Select A
+5. Add created SIP URI
+6. FQDN: sip.vapi.ai
+7. Port should be 5060 by default
+</Step>
+<Step title="Go to Inbound tab">
+Set as follows:
+<Frame>
+	<img src="../../static/images/sip/telynx-inbound.png" />
+</Frame>
+</Step>
+<Step title="Assign your acquired phone number to SIP trunking">
+Go to numbers tab, assign number
+</Step>
+<Step title="Modify SIP invite">
+Modify SIP invite so your VAPI and Telnyx accounts will be matched correctly
+1. Go to numbers, edit the one your will be using
+2. Navigate do voice
+3. Scroll down till the end to find Translated Number
+
+*This setting will modify the SIP Invite to the vapi platform so invites are sent to your vapi sip URI. It will be whatever value you set when you created it.*
+
+4. If your chosen sipURI from previous step is [email protected] , this should be username
+5. Done! You should now be receiving calls! 
+</Step>
+</Steps>
+
+## Outbound
+### On Telnyx
+<Steps>
+<Step title="Set outbound authentication method">
+1. Go to Voice / Sip Trunking / Authentication and routing
+2. Scroll down to outbound calls authentication and:
+- Add the two fixed IPs from VAPI, select Tech Prefix and create a unique 4-digits Tech Prefix (example 1234 - don't use 1234, must be unique to your account)
+<Frame>
+    <img src="../../static/images/sip/telynx-outbound-auth.png" />
+</Frame>
+</Step>
+<Step title="Create outbound voice profiles">
+1. Go to voice / outbound voice profiles
+2. Create profile
+3. Name it as you will (1. details)
+4. Allow as desired destination (2. destinations)
+5. Leave the next screen as is (3. configuration)
+6. Assign the desired sip trunk (4. …)
+7. Complete
+
+Or you an just go to sip trunk / you sip trunk / outbound / and select your just created outbound voice profile. 
+</Step>
+<Step title="Go to Outbound tab to select the country you'll be calling the most">
+Set as follows, choosing the country that you will be making most calls to (example Brazil)
+
+*We recommend creating a separate SIP Trunk for each country you aim to be making most calls to.*
+<Frame>
+    <img src="../../static/images/sip/telynx-outbound-settings.png" />
+</Frame>
+</Step>
+</Steps>
+### On Vapi
+<Steps>
+<Step title="Create a SIP Trunk Credential through Vapi API">
+```json 
+curl -X POST https://api.vapi.ai/credential \
+	-H "Content-Type: application/json" \
+	-H "Authorization: Bearer your-vapi-private-api-key" \
+	-d '{
+		"provider": "byo-sip-trunk",
+		"name": "Telnyx Trunk",
+		"gateways": [
+			{
+				"ip": "sip.telnyx.com"
+			}
+		]
+	}'
+```
+</Step>
+<Step title="Create a Phone Number Associated with the SIP Trunk">
+```json
+curl -X POST https://api.vapi.ai/phone-number \
+	-H "Content-Type: application/json" \
+	-H "Authorization: Bearer your-vapi-private-api-key" \
+		-d '{
+			"provider": "byo-phone-number",
+			"name": "Telnyx SIP Number",
+			"number": "your-sip-phone-number",
+			"numberE164CheckEnabled": false,
+			"credentialId": "your-new-trunk-credential-id-which-you-got-from-previous-step"
+		}'
+```
+</Step>
+<Step title="Start making outbound calls">
+Use this cURL to trigger calls with tech prefix
+```json
+curl --location 'https://api.vapi.ai/call/phone' \
+	--header 'Authorization: Bearer your-vapi-private-api-key' \
+	--header 'Content-Type: application/json' \
+	--data '{
+		"assistantId": "your-assistant-id",
+		"customer": {	
+			"number": "tech-prefix-with-phone-number-without-plus-signal",
+			"numberE164CheckEnabled": false
+		},
+	"phoneNumberId": "your-phone-id"
+}'
+```
+Example of tech-prefix-with-phone-number-without-plus-signal
+- Phone number: +6699999999
+- Tech Prefix: 1234
+- Should look like this: 12346699999999
+- No + as you can see
+
+Done! Outbound should now be working!
+</Step>
+</Steps>

fern/advanced/sip/sip-trunk.mdx

@@ -0,0 +1,94 @@
+---
+title: SIP Trunking Guide for Vapi
+subtitle: How to integrate your SIP provider with Vapi
+slug: advanced/sip/sip-trunk
+---
+
+SIP trunking replaces traditional phone lines with a virtual connection over the internet, allowing your business to make and receive calls via a broadband connection. It connects your internal PBX or VoIP system to a SIP provider, which then routes calls to the Public Switched Telephone Network (PSTN). This setup simplifies your communications infrastructure and often reduces costs.
+
+## 1. Vapi SIP Trunking Options
+
+Vapi supports multiple SIP trunk configurations, including:
+
+- **Telnyx**: Uses SIP gateway domain (e.g., sip.telnyx.com) with IP-based authentication. May require a tech prefix for outbound calls.
+- **Zadarma**: Uses SIP credentials (username/password) with its SIP server (e.g., sip.zadarma.com).
+- **Custom "BYO" SIP Trunk**: Allows integration with any SIP provider. You simply provide the SIP gateway address and the necessary authentication details.
+
+## 2. Setup Process Overview
+
+To set up a SIP trunk in Vapi, follow these steps:
+
+### Obtain Provider Details
+
+Gather the SIP server address, authentication credentials (username/password or IP-based), and at least one phone number (DID) from your provider.
+
+### Create a SIP Trunk Credential in Vapi
+
+Use the Vapi API to create a new credential (type: byo-sip-trunk) with your provider's details. This informs Vapi how to connect to your SIP network.
+
+**Example (using Zadarma):**
+
+```bash
+curl -X POST "https://api.vapi.ai/credential" \
+  -H "Content-Type: application/json" \
+  -H "Authorization: Bearer YOUR_VAPI_PRIVATE_KEY" \
+  -d '{
+    "provider": "byo-sip-trunk",
+    "name": "Zadarma Trunk",
+    "gateways": [{
+      "ip": "sip.zadarma.com"
+    }],
+    "outboundLeadingPlusEnabled": true,
+    "outboundAuthenticationPlan": {
+      "authUsername": "YOUR_SIP_NUMBER",
+      "authPassword": "YOUR_SIP_PASSWORD"
+    }
+  }'
+```
+
+Save the returned Credential ID for later use.
+
+### Associate a Phone Number with the SIP Trunk
+
+Link your external phone number (DID) to the SIP trunk credential in Vapi by creating a Phone Number resource.
+
+**Example:**
+
+```bash
+curl -X POST "https://api.vapi.ai/phone-number" \
+  -H "Content-Type: application/json" \
+  -H "Authorization: Bearer YOUR_VAPI_PRIVATE_KEY" \
+  -d '{
+    "provider": "byo-phone-number",
+    "name": "Zadarma Number",
+    "number": "15551234567",
+    "numberE164CheckEnabled": false,
+    "credentialId": "YOUR_CREDENTIAL_ID"
+  }'
+```
+
+Note the returned Phone Number ID for use in test calls.
+
+### Test Your SIP Trunk
+
+#### Outbound Call Test
+
+Initiate a call through the Vapi dashboard or API to ensure outbound calls are properly routed.
+
+**API Example:**
+
+```json
+POST https://api.vapi.ai/call/phone
+{
+  "assistantId": "YOUR_ASSISTANT_ID",
+  "customer": {
+    "number": "15557654321",
+    "numberE164CheckEnabled": false
+  },
+  "phoneNumberId": "YOUR_PHONE_NUMBER_ID"
+}
+```
+
+#### Inbound Call Test
+
+If inbound routing is configured, call your phone number from an external line. Ensure your provider forwards calls to the correct SIP URI (e.g., `{phoneNumber}@sip.vapi.ai` for Zadarma).

fern/advanced/sip/sip-zadarma.mdx

@@ -0,0 +1,94 @@
+---
+title: Zadarma SIP Integration
+subtitle: How to integrate SIP Zadarma to Vapi
+slug: advanced/sip/zadarma
+---
+
+
+Integrate your Zadarma SIP trunk with Vapi.ai to enable your AI voice assistants to handle calls efficiently. Follow the steps below to set up this integration:
+
+## 1. Retrieve Your Vapi.ai Private Key
+
+- Log in to your Vapi.ai account.
+- Navigate to **Organization Settings**.
+- In the **API Keys** section, copy your **Private Key**.
+
+## 2. Add Your Zadarma SIP Credentials to Vapi.ai
+
+You'll need to send a `curl` request to Vapi.ai's API to add your SIP credentials:
+
+- **Private Key**: Your Vapi.ai private key.
+- **Trunk Name**: A name for your SIP trunk (e.g., "Zadarma Trunk").
+- **Server Address**: The server address provided by Zadarma (e.g., "sip.zadarma.com").
+- **SIP Number**: Your Zadarma SIP number.
+- **SIP Password**: The password for your Zadarma SIP number.
+
+Here's the `curl` command to execute:
+
+```bash
+curl -L 'https://api.vapi.ai/credential' \\
+-H 'Content-Type: application/json' \\
+-H 'Authorization: Bearer YOUR_PRIVATE_KEY' \\
+-d '{
+  "provider": "byo-sip-trunk",
+  "name": "Zadarma Trunk",
+  "gateways": [
+    { "ip": "sip.zadarma.com" }
+  ],
+  "outboundLeadingPlusEnabled": true,
+  "outboundAuthenticationPlan": {
+    "authUsername": "YOUR_SIP_NUMBER",
+    "authPassword": "YOUR_SIP_PASSWORD"
+  }
+}'
+```
+Replace `YOUR_PRIVATE_KEY`, `YOUR_SIP_NUMBER`, and `YOUR_SIP_PASSWORD` with your actual credentials.
+
+If successful, the response will include an `id` for the created credential, which you'll use in the next step.
+
+## 3. Add Your Virtual Number to Vapi.ai
+
+Next, associate your virtual number with the SIP trunk in Vapi.ai:
+
+- **Private Key**: Your Vapi.ai private key.
+- **Number Name**: A name for your virtual number (e.g., "Zadarma Number").
+- **Virtual Number**: Your Zadarma virtual number in international format (e.g., "15551111111").
+- **Credential ID**: The `id` from the previous step.
+
+Use the following `curl` command:
+
+```bash
+curl -L 'https://api.vapi.ai/phone-number' \\
+-H 'Content-Type: application/json' \\
+-H 'Authorization: Bearer YOUR_PRIVATE_KEY' \\
+-d '{
+  "provider": "byo-phone-number",
+  "name": "Zadarma Number",
+  "number": "YOUR_VIRTUAL_NUMBER",
+  "numberE164CheckEnabled": false,
+  "credentialId": "YOUR_CREDENTIAL_ID"
+}'
+```
+
+Replace `YOUR_PRIVATE_KEY`, `YOUR_VIRTUAL_NUMBER`, and `YOUR_CREDENTIAL_ID` with your actual details.
+
+## 4. Assign Your Voice Assistant to Handle Calls
+
+- In your Vapi.ai dashboard, go to the **Build** section and select **Phone Numbers**.
+- Click on your **Zadarma Number**.
+- In the **Inbound Settings** section, assign your voice assistant to handle incoming calls.
+- In the **Outbound Form** section, assign your voice assistant to handle outgoing calls.
+
+## 5. Configure Incoming Call Reception in Zadarma
+
+To forward incoming calls from your Zadarma virtual number to Vapi.ai:
+
+- Log in to your Zadarma account.
+- Navigate to **Settings** → **Virtual phone numbers**.
+- Click the ⚙ (gear) icon next to your number.
+- Open the **External server** tab.
+- Enable **External server (SIP URI)**.
+- Enter the address: `[email protected]` (replace `YOUR_VIRTUAL_NUMBER` with your number in international format).
+- Click **Save**.
+
+By following these steps, your Zadarma SIP trunk will be integrated with Vapi.ai, allowing your AI voice assistants to manage calls effectively.

fern/advanced/calls/sip.mdx → fern/advanced/sip/sip.mdx

@@ -1,7 +1,7 @@
 ---
-title: SIP
+title: SIP Introduction
 subtitle: You can make SIP calls to Vapi Assistants.
-slug: advanced/calls/sip
+slug: advanced/sip
 ---
 
 <Steps>