Skip to content

Commit 5229421

Browse files
authored
Merge pull request #213 from signalwire/Devon/API-link-fixes
API Link fixes
2 parents 5b81447 + 295941f commit 5229421

15 files changed

Lines changed: 76 additions & 76 deletions

File tree

fern/apis/calling/openapi.yaml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7454,7 +7454,7 @@ components:
74547454
description: |-
74557455
Enables emotion detection for the set TTS engine. This allows the AI to express emotions when speaking.
74567456
A global emotion or specific emotions for certain topics can be set within the prompt of the AI.
7457-
IMPORTANT: Only works with [`Cartesia`](/voice/getting-started/voice-and-languages#cartesia) TTS engine.
7457+
IMPORTANT: Only works with [`Cartesia`](/docs/platform/voice/tts/cartesia) TTS engine.
74587458
examples:
74597459
- auto
74607460
speed:
@@ -7464,7 +7464,7 @@ components:
74647464
description: |-
74657465
The speed to use for the specified TTS engine. This allows the AI to speak at a different speed at different points in the conversation.
74667466
The speed behavior can be defined in the prompt of the AI.
7467-
IMPORTANT: Only works with [`Cartesia`](/voice/getting-started/voice-and-languages#cartesia) TTS engine.
7467+
IMPORTANT: Only works with [`Cartesia`](/docs/platform/voice/tts/cartesia) TTS engine.
74687468
examples:
74697469
- auto
74707470
engine:
@@ -7537,7 +7537,7 @@ components:
75377537
description: |-
75387538
Enables emotion detection for the set TTS engine. This allows the AI to express emotions when speaking.
75397539
A global emotion or specific emotions for certain topics can be set within the prompt of the AI.
7540-
IMPORTANT: Only works with [`Cartesia`](/voice/getting-started/voice-and-languages#cartesia) TTS engine.
7540+
IMPORTANT: Only works with [`Cartesia`](/docs/platform/voice/tts/cartesia) TTS engine.
75417541
examples:
75427542
- auto
75437543
speed:
@@ -7547,7 +7547,7 @@ components:
75477547
description: |-
75487548
The speed to use for the specified TTS engine. This allows the AI to speak at a different speed at different points in the conversation.
75497549
The speed behavior can be defined in the prompt of the AI.
7550-
IMPORTANT: Only works with [`Cartesia`](/voice/getting-started/voice-and-languages#cartesia) TTS engine.
7550+
IMPORTANT: Only works with [`Cartesia`](/docs/platform/voice/tts/cartesia) TTS engine.
75517551
examples:
75527552
- auto
75537553
engine:
@@ -10768,7 +10768,7 @@ components:
1076810768
description: |-
1076910769
Allows the user to set and send events to the connected client on the call.
1077010770
This is useful for triggering actions on the client side.
10771-
Commonly used with the [browser-sdk](https://signalwire.com/docs/sdks/reference/browser-sdk/SignalWire%20Client/).
10771+
Commonly used with the [browser-sdk](/docs/browser-sdk/v3/js/reference/signalwire/client).
1077210772
The event object can be any valid JSON object.
1077310773
Any key-value pair in the object is sent to the client as an event type called `user_event`.
1077410774
title: user_event Method

fern/apis/compatibility/openapi.yaml

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -12254,7 +12254,7 @@ webhooks:
1225412254
Payload sent by SignalWire to your Transcription Status Callback URL when the status of a transcription changes.
1225512255
1225612256
Configure this callback by enabling transcription on a recording via the
12257-
[Record](/compatibility-api/cxml/voice/record) verb (`transcribe=true`) and setting `transcribeCallback`
12257+
[Record](/docs/compatibility-api/cxml/reference/voice/record) verb (`transcribe=true`) and setting `transcribeCallback`
1225812258
to your webhook URL.
1225912259
1226012260
Your app can use these parameters to handle the transcription — for example, uploading the text to
@@ -12266,7 +12266,7 @@ webhooks:
1226612266
Payload sent by SignalWire to your Transcription Status Callback URL when the status of a transcription changes.
1226712267
1226812268
Configure this callback by enabling transcription on a recording via the
12269-
[Record](/compatibility-api/cxml/voice/record) verb (`transcribe=true`) and setting `transcribeCallback`
12269+
[Record](/docs/compatibility-api/cxml/reference/voice/record) verb (`transcribe=true`) and setting `transcribeCallback`
1227012270
to your webhook URL.
1227112271
1227212272
Your app can use these parameters to handle the transcription — for example, uploading the text to
@@ -12470,11 +12470,11 @@ webhooks:
1247012470
Payload sent by SignalWire to your Voice Status Callback URL when the status of a call changes.
1247112471
1247212472
Configure this callback using the `StatusCallback` and `StatusCallbackEvent` parameters when
12473-
[creating a call via the API](/rest/compatibility-api/endpoints/create-a-call) or using
12474-
[Dial](/compatibility-api/cxml/voice/dial) with
12475-
[Number](/compatibility-api/cxml/voice/number-noun),
12476-
[SIP](/compatibility-api/cxml/voice/sip-noun), or
12477-
[Conference](/compatibility-api/cxml/voice/conference-noun).
12473+
[creating a call via the API](/docs/compatibility-api/rest/calls/create-a-call) or using
12474+
[Dial](/docs/compatibility-api/cxml/reference/voice/dial) with
12475+
[Number](/docs/compatibility-api/cxml/reference/voice/number),
12476+
[SIP](/docs/compatibility-api/cxml/reference/voice/sip), or
12477+
[Conference](/docs/compatibility-api/cxml/reference/voice/conference).
1247812478
1247912479
Use `StatusCallbackEvent` to receive every call progress event — not just the final status —
1248012480
along with current call state and all parameters below.
@@ -12485,11 +12485,11 @@ webhooks:
1248512485
Payload sent by SignalWire to your Voice Status Callback URL when the status of a call changes.
1248612486
1248712487
Configure this callback using the `StatusCallback` and `StatusCallbackEvent` parameters when
12488-
[creating a call via the API](/rest/compatibility-api/endpoints/create-a-call) or using
12489-
[Dial](/compatibility-api/cxml/voice/dial) with
12490-
[Number](/compatibility-api/cxml/voice/number-noun),
12491-
[SIP](/compatibility-api/cxml/voice/sip-noun), or
12492-
[Conference](/compatibility-api/cxml/voice/conference-noun).
12488+
[creating a call via the API](/docs/compatibility-api/rest/calls/create-a-call) or using
12489+
[Dial](/docs/compatibility-api/cxml/reference/voice/dial) with
12490+
[Number](/docs/compatibility-api/cxml/reference/voice/number),
12491+
[SIP](/docs/compatibility-api/cxml/reference/voice/sip), or
12492+
[Conference](/docs/compatibility-api/cxml/reference/voice/conference).
1249312493
1249412494
Use `StatusCallbackEvent` to receive every call progress event — not just the final status —
1249512495
along with current call state and all parameters below.
@@ -12563,10 +12563,10 @@ webhooks:
1256312563
sending it via email, or forwarding the URL via SMS.
1256412564
1256512565
Configure `RecordingStatusCallback` when
12566-
[creating a call via the API](/rest/compatibility-api/endpoints/create-a-call) or when using
12567-
[Dial](/compatibility-api/cxml/voice/dial),
12568-
[Conference](/compatibility-api/cxml/voice/conference-noun), or
12569-
[Record](/compatibility-api/cxml/voice/record).
12566+
[creating a call via the API](/docs/compatibility-api/rest/calls/create-a-call) or when using
12567+
[Dial](/docs/compatibility-api/cxml/reference/voice/dial),
12568+
[Conference](/docs/compatibility-api/cxml/reference/voice/conference), or
12569+
[Record](/docs/compatibility-api/cxml/reference/voice/record).
1257012570
1257112571
Use `RecordingStatusCallbackEvent` to request callbacks for specific events. If omitted, only the
1257212572
`completed` event is sent. Possible values: `in-progress`, `completed`, `absent`.
@@ -12587,10 +12587,10 @@ webhooks:
1258712587
sending it via email, or forwarding the URL via SMS.
1258812588
1258912589
Configure `RecordingStatusCallback` when
12590-
[creating a call via the API](/rest/compatibility-api/endpoints/create-a-call) or when using
12591-
[Dial](/compatibility-api/cxml/voice/dial),
12592-
[Conference](/compatibility-api/cxml/voice/conference-noun), or
12593-
[Record](/compatibility-api/cxml/voice/record).
12590+
[creating a call via the API](/docs/compatibility-api/rest/calls/create-a-call) or when using
12591+
[Dial](/docs/compatibility-api/cxml/reference/voice/dial),
12592+
[Conference](/docs/compatibility-api/cxml/reference/voice/conference), or
12593+
[Record](/docs/compatibility-api/cxml/reference/voice/record).
1259412594
1259512595
Use `RecordingStatusCallbackEvent` to request callbacks for specific events. If omitted, only the
1259612596
`completed` event is sent. Possible values: `in-progress`, `completed`, `absent`.
@@ -12662,8 +12662,8 @@ webhooks:
1266212662
1266312663
Configure `StatusCallback` at the phone number level via the dashboard
1266412664
(**Phone Numbers** → select a number → **Phone Number Settings**) or programmatically via the
12665-
[create](/rest/compatibility-api/endpoints/create-incoming-phone-number) or
12666-
[update](/rest/compatibility-api/endpoints/update-incoming-phone-number) Incoming Phone Number API endpoints.
12665+
[create](/docs/compatibility-api/rest/incoming-phone-numbers/create-incoming-phone-number) or
12666+
[update](/docs/compatibility-api/rest/incoming-phone-numbers/update-incoming-phone-number) Incoming Phone Number API endpoints.
1266712667
1266812668
By default, the webhook fires only when the call is `completed` or `failed`, making it well-suited
1266912669
for tracking inbound call success rate, call quality, and total call volume in a call center context.
@@ -12675,8 +12675,8 @@ webhooks:
1267512675
1267612676
Configure `StatusCallback` at the phone number level via the dashboard
1267712677
(**Phone Numbers** → select a number → **Phone Number Settings**) or programmatically via the
12678-
[create](/rest/compatibility-api/endpoints/create-incoming-phone-number) or
12679-
[update](/rest/compatibility-api/endpoints/update-incoming-phone-number) Incoming Phone Number API endpoints.
12678+
[create](/docs/compatibility-api/rest/incoming-phone-numbers/create-incoming-phone-number) or
12679+
[update](/docs/compatibility-api/rest/incoming-phone-numbers/update-incoming-phone-number) Incoming Phone Number API endpoints.
1268012680
1268112681
By default, the webhook fires only when the call is `completed` or `failed`, making it well-suited
1268212682
for tracking inbound call success rate, call quality, and total call volume in a call center context.
@@ -12756,7 +12756,7 @@ webhooks:
1275612756
Payload sent by SignalWire to your SMS Status Callback URL when the status of an SMS/MMS message changes.
1275712757
1275812758
Configure this callback using the `StatusCallback` parameter when
12759-
[sending an outgoing message](/rest/compatibility-api/endpoints/create-message).
12759+
[sending an outgoing message](/docs/compatibility-api/rest/messages/create-message).
1276012760
1276112761
There are 8 possible message statuses:
1276212762
@@ -12784,7 +12784,7 @@ webhooks:
1278412784
Payload sent by SignalWire to your SMS Status Callback URL when the status of an SMS/MMS message changes.
1278512785
1278612786
Configure this callback using the `StatusCallback` parameter when
12787-
[sending an outgoing message](/rest/compatibility-api/endpoints/create-message).
12787+
[sending an outgoing message](/docs/compatibility-api/rest/messages/create-message).
1278812788
1278912789
There are 8 possible message statuses:
1279012790

fern/apis/fabric/openapi.yaml

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ paths:
145145
summary: List Fabric Addresses
146146
description: |-
147147
A list of Fabric Addresses. This endpoint uses the bearer token authentication method with the SAT (Subscriber Access Token) which can be
148-
generated using the [Create Subscriber Token endpoint](/apis/rest/fabric/subscribers/create-subscriber-token).
148+
generated using the [Create Subscriber Token endpoint](/docs/apis/fabric/subscribers/create-subscriber-token).
149149

150150
#### Permissions
151151

@@ -188,7 +188,7 @@ paths:
188188
summary: Get Fabric Address
189189
description: |-
190190
Returns a Fabric Address by ID. This endpoint uses the bearer token authentication method with the SAT (Subscriber Access Token) which can be
191-
generated using the [Create Subscriber Token endpoint](/apis/rest/fabric/subscribers/create-subscriber-token).
191+
generated using the [Create Subscriber Token endpoint](/docs/apis/fabric/subscribers/create-subscriber-token).
192192

193193
#### Permissions
194194

@@ -8528,7 +8528,7 @@ components:
85288528
- '{}'
85298529
relayml:
85308530
type: string
8531-
description: A SWML document. For more information on SWML, please go to the [SWML docs](/swml)
8531+
description: A SWML document. For more information on SWML, please go to the [SWML docs](/docs/swml)
85328532
examples:
85338533
- '{ "version": "1.0.0", "sections": { "main": [{ "play": { "url": "https://cdn.signalwire.com/swml/audio.mp3" }}]}};'
85348534
document_version:
@@ -14285,7 +14285,7 @@ components:
1428514285
description: |-
1428614286
Enables emotion detection for the set TTS engine. This allows the AI to express emotions when speaking.
1428714287
A global emotion or specific emotions for certain topics can be set within the prompt of the AI.
14288-
IMPORTANT: Only works with [`Cartesia`](/voice/getting-started/voice-and-languages#cartesia) TTS engine.
14288+
IMPORTANT: Only works with [`Cartesia`](/docs/platform/voice/tts/cartesia) TTS engine.
1428914289
examples:
1429014290
- auto
1429114291
speed:
@@ -14295,7 +14295,7 @@ components:
1429514295
description: |-
1429614296
The speed to use for the specified TTS engine. This allows the AI to speak at a different speed at different points in the conversation.
1429714297
The speed behavior can be defined in the prompt of the AI.
14298-
IMPORTANT: Only works with [`Cartesia`](/voice/getting-started/voice-and-languages#cartesia) TTS engine.
14298+
IMPORTANT: Only works with [`Cartesia`](/docs/platform/voice/tts/cartesia) TTS engine.
1429914299
examples:
1430014300
- auto
1430114301
engine:
@@ -14368,7 +14368,7 @@ components:
1436814368
description: |-
1436914369
Enables emotion detection for the set TTS engine. This allows the AI to express emotions when speaking.
1437014370
A global emotion or specific emotions for certain topics can be set within the prompt of the AI.
14371-
IMPORTANT: Only works with [`Cartesia`](/voice/getting-started/voice-and-languages#cartesia) TTS engine.
14371+
IMPORTANT: Only works with [`Cartesia`](/docs/platform/voice/tts/cartesia) TTS engine.
1437214372
examples:
1437314373
- auto
1437414374
speed:
@@ -14378,7 +14378,7 @@ components:
1437814378
description: |-
1437914379
The speed to use for the specified TTS engine. This allows the AI to speak at a different speed at different points in the conversation.
1438014380
The speed behavior can be defined in the prompt of the AI.
14381-
IMPORTANT: Only works with [`Cartesia`](/voice/getting-started/voice-and-languages#cartesia) TTS engine.
14381+
IMPORTANT: Only works with [`Cartesia`](/docs/platform/voice/tts/cartesia) TTS engine.
1438214382
examples:
1438314383
- auto
1438414384
engine:
@@ -17987,7 +17987,7 @@ components:
1798717987
- **default**: The SIP endpoint will pull the outbound policy setting from the [SIP Profile Settings](https://my.signalwire.com?page=sip_profile/edit). This allows centralized management of outbound call behavior across multiple endpoints from a single configuration.
1798817988
- **passthrough**: The SIP endpoint will be allowed to dial PSTN numbers. This permits outbound calling to traditional phone numbers without restrictions.
1798917989
- **block-pstn**: The SIP endpoint will be blocked from dialing PSTN numbers. Use this to restrict the endpoint from initiating calls to the public telephone network.
17990-
- **resource**: Outbound calls from this SIP endpoint will dial the specified resource and execute its instructions. Requires setting `calling_handler_resource_id` to a valid resource. This enables custom call handling workflows for outbound calls. See the [Fabric REST API](/rest/signalwire-rest/endpoints/fabric) for valid resource types.
17990+
- **resource**: Outbound calls from this SIP endpoint will dial the specified resource and execute its instructions. Requires setting `calling_handler_resource_id` to a valid resource. This enables custom call handling workflows for outbound calls.
1799117991
examples:
1799217992
- default
1799317993
calling_handler_resource_id:
@@ -18110,7 +18110,7 @@ components:
1811018110
- **default**: The SIP endpoint will pull the outbound policy setting from the [SIP Profile Settings](https://my.signalwire.com?page=sip_profile/edit). This allows centralized management of outbound call behavior across multiple endpoints from a single configuration.
1811118111
- **passthrough**: The SIP endpoint will be allowed to dial PSTN numbers. This permits outbound calling to traditional phone numbers without restrictions.
1811218112
- **block-pstn**: The SIP endpoint will be blocked from dialing PSTN numbers. Use this to restrict the endpoint from initiating calls to the public telephone network.
18113-
- **resource**: Outbound calls from this SIP endpoint will dial the specified resource and execute its instructions. Requires setting `calling_handler_resource_id` to a valid resource. This enables custom call handling workflows for outbound calls. See the [Fabric REST API](/rest/signalwire-rest/endpoints/fabric) for valid resource types.
18113+
- **resource**: Outbound calls from this SIP endpoint will dial the specified resource and execute its instructions. Requires setting `calling_handler_resource_id` to a valid resource. This enables custom call handling workflows for outbound calls.
1811418114
examples:
1811518115
- default
1811618116
calling_handler_resource_id:
@@ -18290,7 +18290,7 @@ components:
1829018290
- **default**: The SIP endpoint will pull the outbound policy setting from the [SIP Profile Settings](https://my.signalwire.com?page=sip_profile/edit). This allows centralized management of outbound call behavior across multiple endpoints from a single configuration.
1829118291
- **passthrough**: The SIP endpoint will be allowed to dial PSTN numbers. This permits outbound calling to traditional phone numbers without restrictions.
1829218292
- **block-pstn**: The SIP endpoint will be blocked from dialing PSTN numbers. Use this to restrict the endpoint from initiating calls to the public telephone network.
18293-
- **resource**: Outbound calls from this SIP endpoint will dial the specified resource and execute its instructions. Requires setting `calling_handler_resource_id` to a valid resource. This enables custom call handling workflows for outbound calls. See the [Fabric REST API](/rest/signalwire-rest/endpoints/fabric) for valid resource types.
18293+
- **resource**: Outbound calls from this SIP endpoint will dial the specified resource and execute its instructions. Requires setting `calling_handler_resource_id` to a valid resource. This enables custom call handling workflows for outbound calls.
1829418294
examples:
1829518295
- default
1829618296
calling_handler_resource_id:
@@ -20577,7 +20577,7 @@ components:
2057720577
description: |-
2057820578
Allows the user to set and send events to the connected client on the call.
2057920579
This is useful for triggering actions on the client side.
20580-
Commonly used with the [browser-sdk](https://signalwire.com/docs/sdks/reference/browser-sdk/SignalWire%20Client/).
20580+
Commonly used with the [browser-sdk](/docs/browser-sdk/v3/js/reference/signalwire/client).
2058120581
The event object can be any valid JSON object.
2058220582
Any key-value pair in the object is sent to the client as an event type called `user_event`.
2058320583
title: user_event Method

0 commit comments

Comments
 (0)