Repository navigation
Sync TypeScript Server SDK docs #830
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -122,7 +122,7 @@ print(call["id"]) | |
| </CodeBlock> | ||
| <CodeBlock title="TypeScript — REST client"> | ||
| ```typescript | ||
| // Install: npm install @signalwire/sdk@3.7.1 | ||
| // This sample also runs as JavaScript: save as send-fax.mjs, | ||
| // then run: node send-fax.mjs | ||
| import { RestClient, SwmlBuilder } from "@signalwire/sdk"; | ||
|
|
@@ -135,12 +135,10 @@ const client = new RestClient({ | |
|
|
||
| const swml = new SwmlBuilder() | ||
| .send_fax({ document: "<YOUR_FAX_DOCUMENT_URL>", header_info: "Bayview Taxi receipt" }) | ||
| .render(); // JSON text; parse it to pass the document object to dial() | ||
|
|
||
| const call = await client.calling.dial("<YOUR_CALLER_ID>", "<YOUR_DESTINATION>", { | ||
| swml: JSON.parse(swml), | ||
| }); | ||
| console.log(call.id); | ||
| ``` | ||
|
|
@@ -215,7 +213,7 @@ print(script["id"]) | |
| </CodeBlock> | ||
| <CodeBlock title="TypeScript — REST client"> | ||
| ```typescript | ||
| // Install: npm install @signalwire/sdk@3.7.1 | ||
| // This sample also runs as JavaScript: save as receive-fax-script.mjs, | ||
| // then run: node receive-fax-script.mjs | ||
| import { RestClient, SwmlBuilder } from "@signalwire/sdk"; | ||
|
|
@@ -228,7 +226,7 @@ const client = new RestClient({ | |
|
|
||
| const swml = new SwmlBuilder() | ||
| .receive_fax() | ||
| .render(); // The script's contents are SWML as JSON text | ||
|
|
||
| const script = await client.fabric.swmlScripts.create({ | ||
| name: "Receive faxes", | ||
|
|
@@ -377,7 +375,7 @@ asyncio.run(main()) | |
| </CodeBlock> | ||
| <CodeBlock title="TypeScript — Relay client"> | ||
| ```typescript | ||
| // Install: npm install @signalwire/sdk@3.7.1 | ||
| // Save as send-fax-relay.mts and run: npx tsx send-fax-relay.mts | ||
| import { RelayClient, FaxEvent } from "@signalwire/sdk"; | ||
|
|
||
|
|
@@ -468,7 +466,7 @@ client.run() | |
| </CodeBlock> | ||
| <CodeBlock title="TypeScript — Relay client"> | ||
| ```typescript | ||
| // Install: npm install @signalwire/sdk@3.7.1 | ||
| // Save as receive-fax-relay.mts and run: npx tsx receive-fax-relay.mts | ||
| import { RelayClient, FaxEvent } from "@signalwire/sdk"; | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -124,7 +124,7 @@ print(queue["id"]) | |
| </CodeBlock> | ||
| <CodeBlock title="TypeScript — REST client"> | ||
| ```typescript | ||
| // Install: npm install @signalwire/sdk@3.7.1 | ||
| // This sample also runs as JavaScript: save as create-queue.mjs, | ||
| // then run: node create-queue.mjs | ||
| import { RestClient } from "@signalwire/sdk"; | ||
|
|
@@ -193,7 +193,7 @@ service.serve() | |
| </CodeBlock> | ||
| <CodeBlock title="TypeScript — SWML builder"> | ||
| ```typescript | ||
| // Install: npm install @signalwire/sdk@3.7.1 | ||
| // This sample also runs as JavaScript: save as dispatch-queue.mjs, | ||
| // then run: node dispatch-queue.mjs | ||
| import { SWMLService } from "@signalwire/sdk"; | ||
|
|
@@ -204,13 +204,13 @@ const service = new SWMLService({ | |
| port: 3000, | ||
| basicAuth: ["signalwire", "<YOUR_BASIC_AUTH_PASSWORD>"], | ||
| }); | ||
| const swml = service.getBuilder(); | ||
| swml.say("Thanks for calling Bayview Taxi. A dispatcher will be with you shortly."); | ||
| // The SDK's SWML schema requires transfer_after_bridge on enter_queue, which the | ||
| // platform treats as optional, so skip validation for this verb only. | ||
| swml.addVerb("enter_queue", { queue_name: "dispatch", wait_time: 120 }, { skipValidation: true }); | ||
| // Runs only if the caller leaves the queue without reaching an agent. | ||
| swml.say("All our dispatchers are busy. Please call back in a few minutes.").hangup(); | ||
|
|
||
| await service.serve(); | ||
| ``` | ||
|
|
@@ -295,7 +295,7 @@ print(call["id"]) | |
| </CodeBlock> | ||
| <CodeBlock title="TypeScript — REST client"> | ||
| ```typescript | ||
| // Install: npm install @signalwire/sdk@3.7.1 | ||
| // This sample also runs as JavaScript: save as call-agent.mjs, | ||
| // then run: node call-agent.mjs | ||
| import { RestClient, SwmlBuilder } from "@signalwire/sdk"; | ||
|
|
@@ -312,12 +312,10 @@ const swml = new SwmlBuilder() | |
| // Runs only if no caller is waiting. | ||
| .say("No callers are waiting.") | ||
| .hangup() | ||
| .render(); // JSON text; parse it to pass the document object to dial() | ||
|
|
||
| const call = await client.calling.dial("<YOUR_CALLER_ID>", "<YOUR_AGENT_NUMBER>", { | ||
| swml: JSON.parse(swml), | ||
| }); | ||
| console.log(call.id); | ||
| ``` | ||
|
|
@@ -405,7 +403,7 @@ client.calling.end("<YOUR_CALL_ID>") | |
| </CodeBlock> | ||
| <CodeBlock title="TypeScript — REST client"> | ||
| ```typescript | ||
| // Install: npm install @signalwire/sdk@3.7.1 | ||
| // This sample also runs as JavaScript: save as remove-caller.mjs, | ||
| // then run: node remove-caller.mjs | ||
| import { RestClient } from "@signalwire/sdk"; | ||
|
|
@@ -442,7 +440,11 @@ setup and local testing. | |
| </CodeBlock> | ||
| <CodeBlock title="TypeScript — SWML builder"> | ||
| ```typescript | ||
| swml.addVerb( | ||
| "enter_queue", | ||
| { queue_name: "dispatch", wait_time: 120, status_url: "<YOUR_STATUS_WEBHOOK_URL>" }, | ||
| { skipValidation: true }, | ||
| ); | ||
| ``` | ||
| </CodeBlock> | ||
| <CodeBlock title="YAML"> | ||
|
|
@@ -564,7 +566,7 @@ client.run() | |
| </CodeBlock> | ||
| <CodeBlock title="TypeScript — Relay client"> | ||
| ```typescript | ||
| // Install: npm install @signalwire/sdk@3.7.1 | ||
| // Save as dispatch-queue-relay.mts and run: npx tsx dispatch-queue-relay.mts | ||
| import { RelayClient, QueueEvent } from "@signalwire/sdk"; | ||
|
|
||
|
|
@@ -683,7 +685,7 @@ asyncio.run(main()) | |
| </CodeBlock> | ||
| <CodeBlock title="TypeScript — Relay client"> | ||
| ```typescript | ||
| // Install: npm install @signalwire/sdk@3.7.1 | ||
| // Save as call-agent-relay.mts and run: npx tsx call-agent-relay.mts | ||
| import { RelayClient, ConnectEvent } from "@signalwire/sdk"; | ||
|
|
||
|
|
@@ -805,7 +807,7 @@ for queue in client.queues.list()["data"]: | |
| </CodeBlock> | ||
| <CodeBlock title="TypeScript — REST client"> | ||
| ```typescript | ||
| // Install: npm install @signalwire/sdk@3.7.1 | ||
| // This sample also runs as JavaScript: save as list-queues.mjs, | ||
| // then run: node list-queues.mjs | ||
| import { RestClient } from "@signalwire/sdk"; | ||
|
|
@@ -817,7 +819,7 @@ const client = new RestClient({ | |
| }); | ||
|
|
||
| const queues = await client.queues.list(); | ||
| for (const queue of queues.data ?? []) { | ||
| console.log( | ||
| `${queue.friendly_name} (${queue.id}): ${queue.current_size} waiting, ` + | ||
| `average wait ${queue.average_wait_time} s`, | ||
|
|
@@ -878,7 +880,7 @@ for member in sorted(members, key=lambda m: m["position"]): | |
| </CodeBlock> | ||
| <CodeBlock title="TypeScript — REST client"> | ||
| ```typescript | ||
| // Install: npm install @signalwire/sdk@3.7.1 | ||
| // This sample also runs as JavaScript: save as list-waiting.mjs, | ||
| // then run: node list-waiting.mjs | ||
| import { RestClient } from "@signalwire/sdk"; | ||
|
|
@@ -893,7 +895,7 @@ const members = []; | |
| let params = {}; | ||
| while (true) { | ||
| const page = await client.queues.listMembers("<YOUR_QUEUE_ID>", params); | ||
| members.push(...(page.data ?? [])); | ||
| const nextUrl = page.links?.next; | ||
| if (!nextUrl) break; | ||
| params = Object.fromEntries(new URLSearchParams(nextUrl.split("?")[1])); | ||
|
|
@@ -943,7 +945,7 @@ print(queue["friendly_name"]) | |
| </CodeBlock> | ||
| <CodeBlock title="TypeScript — REST client"> | ||
| ```typescript | ||
| // Install: npm install @signalwire/sdk@3.7.1 | ||
| // This sample also runs as JavaScript: save as update-queue.mjs, | ||
| // then run: node update-queue.mjs | ||
| import { RestClient } from "@signalwire/sdk"; | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -358,7 +358,7 @@ uvicorn.run(app, host="0.0.0.0", port=8080) | |
| </CodeBlock> | ||
| <CodeBlock title="JavaScript — SWML builder"> | ||
| ```javascript | ||
| // Install: npm install @signalwire/sdk@3.7.1 @hono/node-server ws | ||
| // Save as stream-app.mjs and run: node stream-app.mjs | ||
| import { serve } from "@hono/node-server"; | ||
| import { SWMLService } from "@signalwire/sdk"; | ||
|
|
@@ -369,7 +369,8 @@ const service = new SWMLService({ | |
| basicAuth: ["signalwire", "<YOUR_BASIC_AUTH_PASSWORD>"], | ||
| }); | ||
| const swml = service.getBuilder(); | ||
| // The SDK's SWML schema has no stream verb, so skip validation for that verb only. | ||
| swml.addVerb("stream", { url: "<YOUR_AUDIO_STREAM_URL>" }, { skipValidation: true }); | ||
| swml.say("Your call is being streamed. Say a few words.").sleep(20000).say("Goodbye."); | ||
|
|
||
| // SignalWire fetches the call's SWML from the server's root URL. | ||
|
|
@@ -493,10 +494,14 @@ swml = SWMLBuilder(service) | |
|
|
||
| ```javascript title="JavaScript — SWML builder" | ||
| const swml = service.getBuilder(); | ||
| swml.say("You are connected to the echo server. Speak, and you will hear yourself."); | ||
| // The SDK's SWML schema lacks connect's stream settings, so skip validation for this verb only. | ||
| swml.addVerb( | ||
| "connect", | ||
| { to: "stream:<YOUR_AUDIO_STREAM_URL>", codec: "PCMU", realtime: true, name: "echo" }, | ||
| { skipValidation: true }, | ||
| ); | ||
| swml.hangup(); | ||
| ``` | ||
|
|
||
| ```yaml title="YAML" | ||
|
|
@@ -560,9 +565,9 @@ swml.say("The stream has stopped. Goodbye.") | |
| ``` | ||
|
|
||
| ```javascript title="JavaScript — SWML builder" {1,3} | ||
| swml.addVerb("stream", { url: "<YOUR_AUDIO_STREAM_URL>", control_id: "my-stream" }, { skipValidation: true }); | ||
| swml.say("Your call is being streamed. Say a few words.").sleep(20000); | ||
| swml.addVerb("stop_stream", { control_id: "my-stream" }, { skipValidation: true }); | ||
| swml.say("The stream has stopped. Goodbye."); | ||
| ``` | ||
|
|
||
|
|
@@ -703,7 +708,7 @@ asyncio.run(main()) | |
| </CodeBlock> | ||
| <CodeBlock title="TypeScript — Relay client"> | ||
| ```typescript | ||
| // Install: npm install @signalwire/sdk@3.7.1 | ||
| // This sample also runs as JavaScript: save as stream-call-relay.mjs, | ||
| // then run: node stream-call-relay.mjs | ||
| import { RelayClient } from "@signalwire/sdk"; | ||
|
|
@@ -822,7 +827,7 @@ asyncio.run(main()) | |
| </CodeBlock> | ||
| <CodeBlock title="TypeScript — Relay client"> | ||
| ```typescript | ||
| // Install: npm install @signalwire/sdk@3.7.1 | ||
| // This sample also runs as JavaScript: save as echo-call-relay.mjs, | ||
| // then run: node echo-call-relay.mjs | ||
| import { RelayClient } from "@signalwire/sdk"; | ||
|
|
@@ -983,7 +988,7 @@ print("Stream stopped") | |
| </CodeBlock> | ||
| <CodeBlock title="TypeScript — REST client"> | ||
| ```typescript | ||
| // Install: npm install @signalwire/sdk@3.7.1 | ||
| // This sample also runs as JavaScript: save as stream-rest.mjs, | ||
| // then run: node stream-rest.mjs | ||
| import { RestClient } from "@signalwire/sdk"; | ||
|
|
@@ -994,12 +999,11 @@ const client = new RestClient({ | |
| host: "<YOUR_SPACE>.signalwire.com", | ||
| }); | ||
|
|
||
| await client.calling.stream("<YOUR_CALL_ID>", "<YOUR_AUDIO_STREAM_URL>", { | ||
| control_id: "rest-stream", | ||
| }); | ||
| await new Promise((resolve) => setTimeout(resolve, 10_000)); | ||
| await client.calling.streamStop("<YOUR_CALL_ID>", "rest-stream"); | ||
| console.log("Stream stopped"); | ||
| ``` | ||
| </CodeBlock> | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -140,7 +140,7 @@ service.serve() | |
| </CodeBlock> | ||
| <CodeBlock title="TypeScript — SWML builder"> | ||
| ```typescript | ||
| // Install: npm install @signalwire/sdk@3.7.1 | ||
| // This sample also runs as JavaScript: save as forward-calls.mjs, | ||
| // then run: node forward-calls.mjs | ||
| import { SWMLService } from "@signalwire/sdk"; | ||
|
|
@@ -311,9 +311,8 @@ client.run() | |
| </CodeBlock> | ||
| <CodeBlock title="TypeScript — Relay client"> | ||
| ```typescript | ||
| // Install: npm install @signalwire/sdk@3.7.1 | ||
| // Save as forward-relay.mts and run: npx tsx forward-relay.mts | ||
| import { RelayClient } from "@signalwire/sdk"; | ||
|
|
||
| const client = new RelayClient({ | ||
|
|
@@ -323,7 +322,9 @@ const client = new RelayClient({ | |
| }); | ||
|
|
||
| client.onCall(async (call) => { | ||
| // An inbound phone call's device carries the caller's number in params.from_number. | ||
| const { params } = call.device as { params?: { from_number?: string } }; | ||
| const caller = params?.from_number; | ||
|
|
||
| call.on("calling.call.connect", async (event) => { | ||
| const state = event.params.connect_state; | ||
|
|
@@ -350,7 +351,7 @@ client.onCall(async (call) => { | |
| timeout: 20, | ||
| }, | ||
| }]], | ||
| { ringback: [{ type: "ringtone", params: { name: "us" } }] }, | ||
| ); | ||
| await call.waitForEnded(); | ||
| }); | ||
|
|
@@ -441,7 +442,7 @@ print("Forwarding") | |
| </CodeBlock> | ||
| <CodeBlock title="TypeScript — REST client"> | ||
| ```typescript | ||
| // Install: npm install @signalwire/sdk@3.7.1 | ||
| // This sample also runs as JavaScript: save as forward-rest.mjs, | ||
| // then run: node forward-rest.mjs | ||
| import { RestClient, SwmlBuilder } from "@signalwire/sdk"; | ||
|
|
@@ -455,8 +456,8 @@ const client = new RestClient({ | |
| const swml = new SwmlBuilder() | ||
| .connect({ to: "<YOUR_DESTINATION>", from: "${call.from}", timeout: 20 }) | ||
| .say("Sorry, nobody at Bayview Taxi can take your call right now. Please call back later.") | ||
| .render(); // JSON text; parse it to pass the document object to transfer() | ||
| await client.calling.transfer("<YOUR_CALL_ID>", JSON.parse(swml)); | ||
| console.log("Forwarding"); | ||
| ``` | ||
| </CodeBlock> | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This rule and the
@3.7.1pin go the opposite way from #908. #908 replaces "Pinned versions" with unpinned Server SDK installs and a no-minimum-version rule. Under this rule, every reference sync would also have to bump every guide. I'd drop this line and the pin changes on 105-106. The file also conflicts withmain, which moved the Browser pin to@signalwire/js@4.0.0-rc.5.