@signalwire/sdk 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (325) hide show
  1. package/.github/workflows/publish.yml +27 -0
  2. package/.github/workflows/test.yml +17 -0
  3. package/CLAUDE.md +112 -0
  4. package/README.md +254 -0
  5. package/docs/MIGRATION-2.0.md +81 -0
  6. package/docs/agent-guide.md +869 -0
  7. package/docs/agent_guide.md +1026 -0
  8. package/docs/api-reference.md +2420 -0
  9. package/docs/api_reference.md +1301 -0
  10. package/docs/architecture.md +843 -0
  11. package/docs/cli-guide.md +579 -0
  12. package/docs/cli_guide.md +448 -0
  13. package/docs/cloud_functions_guide.md +474 -0
  14. package/docs/configuration.md +422 -0
  15. package/docs/contexts-guide.md +787 -0
  16. package/docs/contexts_guide.md +511 -0
  17. package/docs/datamap-guide.md +1141 -0
  18. package/docs/datamap_guide.md +595 -0
  19. package/docs/llm_parameters.md +239 -0
  20. package/docs/mcp_gateway_reference.md +648 -0
  21. package/docs/mcp_integration.md +108 -0
  22. package/docs/prefabs-guide.md +800 -0
  23. package/docs/sdk_features.md +477 -0
  24. package/docs/security.md +436 -0
  25. package/docs/serverless-guide.md +513 -0
  26. package/docs/skills-guide.md +857 -0
  27. package/docs/skills-system.md +301 -0
  28. package/docs/skills_parameter_schema.md +392 -0
  29. package/docs/skills_system.md +467 -0
  30. package/docs/swaig-reference.md +1627 -0
  31. package/docs/swaig_reference.md +910 -0
  32. package/docs/swml_service_guide.md +600 -0
  33. package/docs/third_party_skills.md +533 -0
  34. package/docs/web_service.md +677 -0
  35. package/examples/README.md +131 -0
  36. package/examples/advanced-datamap.ts +100 -0
  37. package/examples/advanced-dynamic-config.ts +70 -0
  38. package/examples/auto-vivified.ts +94 -0
  39. package/examples/call-flow.ts +63 -0
  40. package/examples/comprehensive-dynamic.ts +125 -0
  41. package/examples/contexts-steps.ts +65 -0
  42. package/examples/custom-path.ts +45 -0
  43. package/examples/datamap-tools.ts +55 -0
  44. package/examples/datasphere-multi-instance.ts +63 -0
  45. package/examples/datasphere-serverless-env.ts +68 -0
  46. package/examples/datasphere-webhook-env.ts +66 -0
  47. package/examples/datasphere.ts +37 -0
  48. package/examples/declarative.ts +100 -0
  49. package/examples/dynamic-config.ts +54 -0
  50. package/examples/dynamic-info-gatherer.ts +69 -0
  51. package/examples/dynamic-swml-service.ts +67 -0
  52. package/examples/gather-info.ts +71 -0
  53. package/examples/gather-per-question-functions-demo.ts +140 -0
  54. package/examples/joke-agent.ts +34 -0
  55. package/examples/kubernetes-agent.ts +45 -0
  56. package/examples/llm-params.ts +69 -0
  57. package/examples/mcp-agent.ts +84 -0
  58. package/examples/mcp-gateway.ts +35 -0
  59. package/examples/multi-agent.ts +73 -0
  60. package/examples/multi-endpoint.ts +79 -0
  61. package/examples/pom-prompt.ts +71 -0
  62. package/examples/prefab-concierge.ts +47 -0
  63. package/examples/prefab-faq.ts +54 -0
  64. package/examples/prefab-info-gatherer.ts +33 -0
  65. package/examples/prefab-receptionist.ts +36 -0
  66. package/examples/prefab-survey.ts +68 -0
  67. package/examples/record-call.ts +67 -0
  68. package/examples/relay-demo.ts +33 -0
  69. package/examples/room-and-sip.ts +94 -0
  70. package/examples/serverless-lambda.ts +35 -0
  71. package/examples/session-state.ts +83 -0
  72. package/examples/simple-agent.ts +36 -0
  73. package/examples/simple-static.ts +29 -0
  74. package/examples/skills-demo.ts +38 -0
  75. package/examples/step-function-inheritance-demo.ts +124 -0
  76. package/examples/swaig-features.ts +187 -0
  77. package/examples/swml-service-routing.ts +66 -0
  78. package/examples/swml-service.ts +38 -0
  79. package/examples/tap.ts +68 -0
  80. package/examples/verb-methods.ts +45 -0
  81. package/examples/web-search-multi-instance.ts +72 -0
  82. package/examples/web-search.ts +38 -0
  83. package/examples/wikipedia.ts +36 -0
  84. package/livewire/README.md +140 -0
  85. package/livewire/docs/migration-guide.md +228 -0
  86. package/livewire/examples/livewire-basic-agent.ts +74 -0
  87. package/livewire/examples/livewire-handoff.ts +197 -0
  88. package/livewire/examples/livewire-multi-tool.ts +117 -0
  89. package/package.json +38 -0
  90. package/relay/README.md +70 -0
  91. package/relay/RELAY_IMPLEMENTATION_GUIDE.md +1257 -0
  92. package/relay/docs/call-methods.md +474 -0
  93. package/relay/docs/client-reference.md +142 -0
  94. package/relay/docs/events.md +134 -0
  95. package/relay/docs/getting-started.md +134 -0
  96. package/relay/docs/guide.md +306 -0
  97. package/relay/docs/messaging.md +182 -0
  98. package/relay/examples/relay-inbound.ts +66 -0
  99. package/relay/examples/relay-messaging.ts +71 -0
  100. package/relay/examples/relay-outbound.ts +76 -0
  101. package/rest/README.md +95 -0
  102. package/rest/docs/calling.md +273 -0
  103. package/rest/docs/client-reference.md +107 -0
  104. package/rest/docs/compat.md +204 -0
  105. package/rest/docs/fabric.md +183 -0
  106. package/rest/docs/getting-started.md +110 -0
  107. package/rest/docs/guide.md +351 -0
  108. package/rest/docs/namespaces.md +285 -0
  109. package/rest/examples/rest-10dlc-registration.ts +161 -0
  110. package/rest/examples/rest-calling-ivr-and-ai.ts +102 -0
  111. package/rest/examples/rest-calling-play-and-record.ts +91 -0
  112. package/rest/examples/rest-client.ts +65 -0
  113. package/rest/examples/rest-compat-laml.ts +210 -0
  114. package/rest/examples/rest-datasphere-search.ts +82 -0
  115. package/rest/examples/rest-fabric-conferences-and-routing.ts +144 -0
  116. package/rest/examples/rest-fabric-subscribers-and-sip.ts +108 -0
  117. package/rest/examples/rest-fabric-swml-and-callflows.ts +99 -0
  118. package/rest/examples/rest-manage-resources.ts +65 -0
  119. package/rest/examples/rest-phone-number-management.ts +197 -0
  120. package/rest/examples/rest-queues-mfa-and-recordings.ts +143 -0
  121. package/rest/examples/rest-video-rooms.ts +186 -0
  122. package/src/AgentBase.ts +2489 -0
  123. package/src/AgentServer.ts +415 -0
  124. package/src/AuthHandler.ts +256 -0
  125. package/src/ConfigLoader.ts +447 -0
  126. package/src/ContextBuilder.ts +1150 -0
  127. package/src/DataMap.ts +449 -0
  128. package/src/FunctionResult.ts +866 -0
  129. package/src/Logger.ts +337 -0
  130. package/src/PomBuilder.ts +439 -0
  131. package/src/PromptManager.ts +133 -0
  132. package/src/SWMLHandler.ts +298 -0
  133. package/src/SWMLService.ts +717 -0
  134. package/src/SchemaUtils.ts +361 -0
  135. package/src/SecurityUtils.ts +153 -0
  136. package/src/ServerlessAdapter.ts +221 -0
  137. package/src/SessionManager.ts +311 -0
  138. package/src/SslConfig.ts +118 -0
  139. package/src/SwaigFunction.ts +276 -0
  140. package/src/SwmlBuilder.ts +258 -0
  141. package/src/SwmlVerbMethods.generated.ts +234 -0
  142. package/src/TypeInference.ts +181 -0
  143. package/src/WebService.ts +619 -0
  144. package/src/cli/agent-loader.ts +166 -0
  145. package/src/cli/mock-data.ts +111 -0
  146. package/src/cli/swaig-test.ts +452 -0
  147. package/src/generateVerbTypes.ts +322 -0
  148. package/src/index.ts +167 -0
  149. package/src/livewire/index.ts +950 -0
  150. package/src/prefabs/ConciergeAgent.ts +287 -0
  151. package/src/prefabs/FAQBotAgent.ts +384 -0
  152. package/src/prefabs/InfoGathererAgent.ts +339 -0
  153. package/src/prefabs/ReceptionistAgent.ts +366 -0
  154. package/src/prefabs/SurveyAgent.ts +646 -0
  155. package/src/prefabs/index.ts +27 -0
  156. package/src/relay/Action.ts +314 -0
  157. package/src/relay/Call.ts +854 -0
  158. package/src/relay/Deferred.ts +71 -0
  159. package/src/relay/Message.ts +148 -0
  160. package/src/relay/RelayClient.ts +1036 -0
  161. package/src/relay/RelayError.ts +14 -0
  162. package/src/relay/RelayEvent.ts +892 -0
  163. package/src/relay/constants.ts +132 -0
  164. package/src/relay/index.ts +123 -0
  165. package/src/relay/types.ts +149 -0
  166. package/src/rest/HttpClient.ts +103 -0
  167. package/src/rest/RestError.ts +31 -0
  168. package/src/rest/base/BaseResource.ts +19 -0
  169. package/src/rest/base/CrudResource.ts +51 -0
  170. package/src/rest/base/CrudWithAddresses.ts +26 -0
  171. package/src/rest/index.ts +200 -0
  172. package/src/rest/namespaces/addresses.ts +32 -0
  173. package/src/rest/namespaces/calling.ts +187 -0
  174. package/src/rest/namespaces/chat.ts +20 -0
  175. package/src/rest/namespaces/compat.ts +352 -0
  176. package/src/rest/namespaces/datasphere.ts +45 -0
  177. package/src/rest/namespaces/fabric.ts +222 -0
  178. package/src/rest/namespaces/imported-numbers.ts +20 -0
  179. package/src/rest/namespaces/logs.ts +84 -0
  180. package/src/rest/namespaces/lookup.ts +21 -0
  181. package/src/rest/namespaces/mfa.ts +30 -0
  182. package/src/rest/namespaces/number-groups.ts +38 -0
  183. package/src/rest/namespaces/phone-numbers.ts +44 -0
  184. package/src/rest/namespaces/project.ts +36 -0
  185. package/src/rest/namespaces/pubsub.ts +20 -0
  186. package/src/rest/namespaces/queues.ts +33 -0
  187. package/src/rest/namespaces/recordings.ts +28 -0
  188. package/src/rest/namespaces/registry.ts +101 -0
  189. package/src/rest/namespaces/short-codes.ts +28 -0
  190. package/src/rest/namespaces/sip-profile.ts +25 -0
  191. package/src/rest/namespaces/verified-callers.ts +27 -0
  192. package/src/rest/namespaces/video.ts +165 -0
  193. package/src/rest/pagination.ts +84 -0
  194. package/src/rest/types.ts +61 -0
  195. package/src/schema.json +12250 -0
  196. package/src/skills/SkillBase.ts +547 -0
  197. package/src/skills/SkillManager.ts +415 -0
  198. package/src/skills/SkillRegistry.ts +367 -0
  199. package/src/skills/builtin/api_ninjas_trivia.ts +280 -0
  200. package/src/skills/builtin/ask_claude.ts +241 -0
  201. package/src/skills/builtin/claude_skills.ts +978 -0
  202. package/src/skills/builtin/custom_skills.ts +312 -0
  203. package/src/skills/builtin/datasphere.ts +438 -0
  204. package/src/skills/builtin/datasphere_serverless.ts +339 -0
  205. package/src/skills/builtin/datetime.ts +130 -0
  206. package/src/skills/builtin/google_maps.ts +651 -0
  207. package/src/skills/builtin/index.ts +88 -0
  208. package/src/skills/builtin/info_gatherer.ts +405 -0
  209. package/src/skills/builtin/joke.ts +191 -0
  210. package/src/skills/builtin/math.ts +142 -0
  211. package/src/skills/builtin/mcp_gateway.ts +677 -0
  212. package/src/skills/builtin/native_vector_search.ts +901 -0
  213. package/src/skills/builtin/play_background_file.ts +358 -0
  214. package/src/skills/builtin/spider.ts +869 -0
  215. package/src/skills/builtin/swml_transfer.ts +635 -0
  216. package/src/skills/builtin/weather_api.ts +248 -0
  217. package/src/skills/builtin/web_search.ts +1074 -0
  218. package/src/skills/builtin/wikipedia_search.ts +299 -0
  219. package/src/skills/index.ts +12 -0
  220. package/src/types.ts +132 -0
  221. package/tests/AgentBase.test.ts +1093 -0
  222. package/tests/AgentServer.test.ts +126 -0
  223. package/tests/AuthHandler.test.ts +133 -0
  224. package/tests/ConfigLoader.test.ts +151 -0
  225. package/tests/ContextBuilder.test.ts +108 -0
  226. package/tests/DataMap.test.ts +367 -0
  227. package/tests/EphemeralSkillCopy.test.ts +107 -0
  228. package/tests/FunctionResult.test.ts +298 -0
  229. package/tests/GracefulShutdown.test.ts +46 -0
  230. package/tests/Logger.test.ts +420 -0
  231. package/tests/PomBuilder.test.ts +228 -0
  232. package/tests/ProxyDetection.test.ts +228 -0
  233. package/tests/SWMLService.test.ts +320 -0
  234. package/tests/SWMLVerbHandler.test.ts +523 -0
  235. package/tests/SchemaUtils.test.ts +106 -0
  236. package/tests/SchemaUtils.verb.test.ts +206 -0
  237. package/tests/SecurityUtils.test.ts +192 -0
  238. package/tests/ServerlessAdapter.test.ts +222 -0
  239. package/tests/SessionManager.test.ts +257 -0
  240. package/tests/SkillBaseFeatures.test.ts +130 -0
  241. package/tests/SkillMultiInstance.test.ts +102 -0
  242. package/tests/SkillParameterSchemas.test.ts +134 -0
  243. package/tests/SkillRegistrySchema.test.ts +84 -0
  244. package/tests/SslConfig.test.ts +97 -0
  245. package/tests/SwmlBuilder.test.ts +400 -0
  246. package/tests/TypeInference.test.ts +165 -0
  247. package/tests/VerbHandlerRegistry.test.ts +128 -0
  248. package/tests/cli/mock-data.test.ts +113 -0
  249. package/tests/cli/swaig-test.test.ts +108 -0
  250. package/tests/examples.test.ts +194 -0
  251. package/tests/fixtures/scrape-parity/README.md +53 -0
  252. package/tests/fixtures/scrape-parity/expected/01_simple_article.json +5 -0
  253. package/tests/fixtures/scrape-parity/expected/02_class_based_noise.json +5 -0
  254. package/tests/fixtures/scrape-parity/expected/03_nested_containers.json +5 -0
  255. package/tests/fixtures/scrape-parity/expected/04_bare_body.json +5 -0
  256. package/tests/fixtures/scrape-parity/expected/05_malformed.json +5 -0
  257. package/tests/fixtures/scrape-parity/expected/06_multi_class.json +5 -0
  258. package/tests/fixtures/scrape-parity/expected/07_anchor_pattern.json +5 -0
  259. package/tests/fixtures/scrape-parity/expected/08_inline_script.json +5 -0
  260. package/tests/fixtures/scrape-parity/expected/09_whitespace_nbsp.json +5 -0
  261. package/tests/fixtures/scrape-parity/expected/10_entity_unicode.json +5 -0
  262. package/tests/fixtures/scrape-parity/expected/11_cdata_comments.json +5 -0
  263. package/tests/fixtures/scrape-parity/expected/12_deep_nested_removals.json +5 -0
  264. package/tests/fixtures/scrape-parity/html/01_simple_article.html +18 -0
  265. package/tests/fixtures/scrape-parity/html/02_class_based_noise.html +18 -0
  266. package/tests/fixtures/scrape-parity/html/03_nested_containers.html +13 -0
  267. package/tests/fixtures/scrape-parity/html/04_bare_body.html +9 -0
  268. package/tests/fixtures/scrape-parity/html/05_malformed.html +11 -0
  269. package/tests/fixtures/scrape-parity/html/06_multi_class.html +18 -0
  270. package/tests/fixtures/scrape-parity/html/07_anchor_pattern.html +12 -0
  271. package/tests/fixtures/scrape-parity/html/08_inline_script.html +17 -0
  272. package/tests/fixtures/scrape-parity/html/09_whitespace_nbsp.html +21 -0
  273. package/tests/fixtures/scrape-parity/html/10_entity_unicode.html +10 -0
  274. package/tests/fixtures/scrape-parity/html/11_cdata_comments.html +13 -0
  275. package/tests/fixtures/scrape-parity/html/12_deep_nested_removals.html +24 -0
  276. package/tests/fixtures/scrape-parity/python_extract.py +109 -0
  277. package/tests/livewire/livewire.test.ts +780 -0
  278. package/tests/mcp.test.ts +221 -0
  279. package/tests/prefabs/prefabs.test.ts +1093 -0
  280. package/tests/relay/Action.test.ts +392 -0
  281. package/tests/relay/Call.test.ts +535 -0
  282. package/tests/relay/Deferred.test.ts +71 -0
  283. package/tests/relay/Message.test.ts +164 -0
  284. package/tests/relay/RelayClient.test.ts +779 -0
  285. package/tests/relay/RelayEvent.test.ts +463 -0
  286. package/tests/relay/helpers.ts +79 -0
  287. package/tests/rest/HttpClient.test.ts +274 -0
  288. package/tests/rest/RestError.test.ts +53 -0
  289. package/tests/rest/calling.test.ts +156 -0
  290. package/tests/rest/client.test.ts +197 -0
  291. package/tests/rest/compat.test.ts +335 -0
  292. package/tests/rest/datasphere.test.ts +71 -0
  293. package/tests/rest/fabric.test.ts +186 -0
  294. package/tests/rest/helpers.ts +95 -0
  295. package/tests/rest/logs.test.ts +68 -0
  296. package/tests/rest/pagination.test.ts +133 -0
  297. package/tests/rest/registry.test.ts +94 -0
  298. package/tests/rest/relay-rest.test.ts +290 -0
  299. package/tests/rest/video.test.ts +173 -0
  300. package/tests/setup.ts +6 -0
  301. package/tests/skills/SkillBase.test.ts +108 -0
  302. package/tests/skills/SkillManager.test.ts +268 -0
  303. package/tests/skills/SkillRegistry.test.ts +176 -0
  304. package/tests/skills/builtin.test.ts +1472 -0
  305. package/tests/skills/claude-skills.test.ts +54 -0
  306. package/tests/skills/custom-skills.test.ts +53 -0
  307. package/tests/skills/datasphere-serverless.test.ts +70 -0
  308. package/tests/skills/datasphere.test.ts +107 -0
  309. package/tests/skills/datetime.test.ts +101 -0
  310. package/tests/skills/google-maps.test.ts +78 -0
  311. package/tests/skills/info-gatherer.test.ts +411 -0
  312. package/tests/skills/joke.test.ts +81 -0
  313. package/tests/skills/math.test.ts +68 -0
  314. package/tests/skills/mcp-gateway.test.ts +101 -0
  315. package/tests/skills/play-background.test.ts +54 -0
  316. package/tests/skills/spider.test.ts +108 -0
  317. package/tests/skills/swml-transfer.test.ts +178 -0
  318. package/tests/skills/trivia.test.ts +54 -0
  319. package/tests/skills/vector-search.test.ts +135 -0
  320. package/tests/skills/weather-api.test.ts +77 -0
  321. package/tests/skills/web-search-parity.test.ts +59 -0
  322. package/tests/skills/web-search.test.ts +103 -0
  323. package/tests/skills/wikipedia.test.ts +63 -0
  324. package/tsconfig.json +18 -0
  325. package/vitest.config.ts +9 -0
@@ -0,0 +1,134 @@
1
+ # Events
2
+
3
+ RELAY events are server-pushed notifications about call state changes and operation results. Events arrive over the WebSocket as `signalwire.event` JSON-RPC messages and are automatically routed to the correct `Call` object.
4
+
5
+ ## Listening for Events
6
+
7
+ ### On a Call
8
+
9
+ ```python
10
+ @client.on_call
11
+ async def handle(call):
12
+ # Register a listener
13
+ call.on("calling.call.play", lambda event: print(f"Play: {event.params}"))
14
+
15
+ # Or wait for a specific event
16
+ event = await call.wait_for("calling.call.state",
17
+ predicate=lambda e: e.params.get("call_state") == "ended",
18
+ timeout=60.0,
19
+ )
20
+ ```
21
+
22
+ ### Via Actions
23
+
24
+ Actions returned by `play()`, `record()`, etc. have a `wait()` method that resolves when the operation completes:
25
+
26
+ ```python
27
+ action = await call.play([{"type": "tts", "params": {"text": "Hello"}}])
28
+ event = await action.wait(timeout=30.0)
29
+ # event is a RelayEvent with the terminal state
30
+ ```
31
+
32
+ ## Event Types
33
+
34
+ All event type constants are importable from `signalwire_agents.relay`:
35
+
36
+ | Constant | Value | Description |
37
+ |----------|-------|-------------|
38
+ | `EVENT_CALL_STATE` | `calling.call.state` | Call state changes (created, ringing, answered, ending, ended) |
39
+ | `EVENT_CALL_RECEIVE` | `calling.call.receive` | Inbound call notification |
40
+ | `EVENT_CALL_PLAY` | `calling.call.play` | Play operation state changes |
41
+ | `EVENT_CALL_RECORD` | `calling.call.record` | Record operation state changes |
42
+ | `EVENT_CALL_COLLECT` | `calling.call.collect` | Input collection results |
43
+ | `EVENT_CALL_CONNECT` | `calling.call.connect` | Bridge/connect state changes |
44
+ | `EVENT_CALL_DETECT` | `calling.call.detect` | Detection results |
45
+ | `EVENT_CALL_FAX` | `calling.call.fax` | Fax operation state changes |
46
+ | `EVENT_CALL_TAP` | `calling.call.tap` | Tap operation state changes |
47
+ | `EVENT_CALL_STREAM` | `calling.call.stream` | Stream operation state changes |
48
+ | `EVENT_CALL_SEND_DIGITS` | `calling.call.send_digits` | DTMF send completion |
49
+ | `EVENT_CALL_DIAL` | `calling.call.dial` | Outbound dial progress |
50
+ | `EVENT_CALL_REFER` | `calling.call.refer` | SIP REFER results |
51
+ | `EVENT_CALL_DENOISE` | `calling.call.denoise` | Denoise state changes |
52
+ | `EVENT_CALL_PAY` | `calling.call.pay` | Payment state changes |
53
+ | `EVENT_CALL_QUEUE` | `calling.call.queue` | Queue state changes |
54
+ | `EVENT_CALL_ECHO` | `calling.call.echo` | Echo state changes |
55
+ | `EVENT_CALL_TRANSCRIBE` | `calling.call.transcribe` | Transcription state changes |
56
+ | `EVENT_CONFERENCE` | `calling.conference` | Conference state changes |
57
+ | `EVENT_CALLING_ERROR` | `calling.error` | Error events |
58
+ | `EVENT_MESSAGING_RECEIVE` | `messaging.receive` | Inbound message received |
59
+ | `EVENT_MESSAGING_STATE` | `messaging.state` | Outbound message state change |
60
+
61
+ ## Typed Event Classes
62
+
63
+ Raw events are always `RelayEvent` with a `params` dict. For convenience, typed event classes provide named properties:
64
+
65
+ ```python
66
+ from signalwire_agents.relay import CallStateEvent, PlayEvent, RecordEvent, parse_event
67
+
68
+ # Automatic parsing
69
+ event = parse_event(raw_payload)
70
+
71
+ # Or construct directly
72
+ if event.event_type == "calling.call.state":
73
+ state_event = CallStateEvent.from_payload(raw_payload)
74
+ print(state_event.call_state) # "answered"
75
+ print(state_event.end_reason) # "hangup" (only on ended)
76
+ ```
77
+
78
+ ### Available Typed Events
79
+
80
+ | Class | Key Properties |
81
+ |-------|---------------|
82
+ | `CallStateEvent` | `call_state`, `end_reason`, `direction`, `device` |
83
+ | `CallReceiveEvent` | `call_state`, `direction`, `device`, `node_id`, `context`, `tag` |
84
+ | `PlayEvent` | `control_id`, `state` |
85
+ | `RecordEvent` | `control_id`, `state`, `url`, `duration`, `size` |
86
+ | `CollectEvent` | `control_id`, `state`, `result`, `final` |
87
+ | `ConnectEvent` | `connect_state`, `peer` |
88
+ | `DetectEvent` | `control_id`, `detect` |
89
+ | `FaxEvent` | `control_id`, `fax` |
90
+ | `TapEvent` | `control_id`, `state`, `tap`, `device` |
91
+ | `StreamEvent` | `control_id`, `state`, `url`, `name` |
92
+ | `SendDigitsEvent` | `control_id`, `state` |
93
+ | `DialEvent` | `tag`, `dial_state`, `call` |
94
+ | `ReferEvent` | `state`, `sip_refer_to`, `sip_refer_response_code` |
95
+ | `DenoiseEvent` | `denoised` |
96
+ | `PayEvent` | `control_id`, `state` |
97
+ | `QueueEvent` | `control_id`, `status`, `queue_id`, `queue_name`, `position`, `size` |
98
+ | `EchoEvent` | `state` |
99
+ | `TranscribeEvent` | `control_id`, `state`, `url`, `duration`, `size` |
100
+ | `HoldEvent` | `state` |
101
+ | `ConferenceEvent` | `conference_id`, `name`, `status` |
102
+ | `CallingErrorEvent` | `code`, `message` |
103
+ | `MessageReceiveEvent` | `message_id`, `context`, `direction`, `from_number`, `to_number`, `body`, `media`, `segments`, `message_state`, `tags` |
104
+ | `MessageStateEvent` | `message_id`, `context`, `direction`, `from_number`, `to_number`, `body`, `media`, `segments`, `message_state`, `reason`, `tags` |
105
+
106
+ ## Call States
107
+
108
+ ```
109
+ created -> ringing -> answered -> ending -> ended
110
+ ```
111
+
112
+ Constants: `CALL_STATE_CREATED`, `CALL_STATE_RINGING`, `CALL_STATE_ANSWERED`, `CALL_STATE_ENDING`, `CALL_STATE_ENDED`
113
+
114
+ ## End Reasons
115
+
116
+ When a call reaches the `ended` state, the `end_reason` field indicates why:
117
+
118
+ | Reason | Description |
119
+ |--------|-------------|
120
+ | `hangup` | Normal hangup |
121
+ | `cancel` | Caller cancelled |
122
+ | `busy` | Destination busy |
123
+ | `noAnswer` | No answer |
124
+ | `decline` | Call declined |
125
+ | `error` | Error occurred |
126
+ | `abandoned` | Call abandoned |
127
+ | `max_duration` | Max duration reached |
128
+ | `not_found` | Destination not found |
129
+
130
+ ## Message States
131
+
132
+ Outbound messages progress through: `queued` → `initiated` → `sent` → `delivered` (or `undelivered`/`failed`).
133
+
134
+ Constants: `MESSAGE_STATE_QUEUED`, `MESSAGE_STATE_INITIATED`, `MESSAGE_STATE_SENT`, `MESSAGE_STATE_DELIVERED`, `MESSAGE_STATE_UNDELIVERED`, `MESSAGE_STATE_FAILED`, `MESSAGE_STATE_RECEIVED`
@@ -0,0 +1,134 @@
1
+ # Getting Started with RELAY
2
+
3
+ The RELAY client connects to SignalWire via WebSocket and gives you real-time, imperative control over phone calls using Python's asyncio.
4
+
5
+ ## Installation
6
+
7
+ The RELAY client is included in the `@signalwire/sdk` package:
8
+
9
+ ```bash
10
+ pip install @signalwire/sdk
11
+ ```
12
+
13
+ The only additional dependency is `websockets>=12.0`, which is installed automatically.
14
+
15
+ ## Configuration
16
+
17
+ You need three things to connect:
18
+
19
+ | Parameter | Env Var | Description |
20
+ |-----------|---------|-------------|
21
+ | `project` | `SIGNALWIRE_PROJECT_ID` | Your SignalWire project ID |
22
+ | `token` | `SIGNALWIRE_API_TOKEN` | Your SignalWire API token |
23
+ | `host` | `SIGNALWIRE_SPACE` | Your space hostname (e.g. `example.signalwire.com`) |
24
+
25
+ Alternatively, you can authenticate with a JWT token:
26
+
27
+ | Parameter | Env Var | Description |
28
+ |-----------|---------|-------------|
29
+ | `jwt_token` | `SIGNALWIRE_JWT_TOKEN` | A SignalWire JWT auth token |
30
+
31
+ ## Minimal Example
32
+
33
+ ```python
34
+ from signalwire_agents.relay import RelayClient
35
+
36
+ client = RelayClient(
37
+ project="your-project-id",
38
+ token="your-api-token",
39
+ host="example.signalwire.com",
40
+ contexts=["default"],
41
+ )
42
+
43
+ @client.on_call
44
+ async def handle(call):
45
+ await call.answer()
46
+ action = await call.play([{"type": "tts", "params": {"text": "Hello!"}}])
47
+ await action.wait()
48
+ await call.hangup()
49
+
50
+ client.run()
51
+ ```
52
+
53
+ Or use environment variables and skip the constructor args:
54
+
55
+ ```bash
56
+ export SIGNALWIRE_PROJECT_ID=your-project-id
57
+ export SIGNALWIRE_API_TOKEN=your-api-token
58
+ export SIGNALWIRE_SPACE=example.signalwire.com
59
+ ```
60
+
61
+ ```python
62
+ from signalwire_agents.relay import RelayClient
63
+
64
+ client = RelayClient(contexts=["default"])
65
+
66
+ @client.on_call
67
+ async def handle(call):
68
+ await call.answer()
69
+ await call.hangup()
70
+
71
+ client.run()
72
+ ```
73
+
74
+ ## Contexts
75
+
76
+ Contexts are topics your client subscribes to for receiving inbound calls. When a call arrives on a context you're subscribed to, your `@client.on_call` handler is invoked.
77
+
78
+ ```python
79
+ # Subscribe at connect time
80
+ client = RelayClient(contexts=["sales", "support"])
81
+
82
+ # Or dynamically after connecting
83
+ await client.receive(["billing"])
84
+ await client.unreceive(["sales"])
85
+ ```
86
+
87
+ ## Making Outbound Calls
88
+
89
+ Use `client.dial()` to place an outbound call:
90
+
91
+ ```python
92
+ call = await client.dial([
93
+ [{"type": "phone", "params": {"to_number": "+15551234567", "from_number": "+15559876543"}}]
94
+ ])
95
+ # call is now a live Call object
96
+ action = await call.play([{"type": "tts", "params": {"text": "This is an outbound call."}}])
97
+ await action.wait()
98
+ await call.hangup()
99
+ ```
100
+
101
+ The outer list represents serial attempts; the inner list represents parallel attempts. For example, to try two numbers simultaneously:
102
+
103
+ ```python
104
+ call = await client.dial([
105
+ [
106
+ {"type": "phone", "params": {"to_number": "+15551111111", "from_number": "+15559876543"}},
107
+ {"type": "phone", "params": {"to_number": "+15552222222", "from_number": "+15559876543"}},
108
+ ]
109
+ ])
110
+ ```
111
+
112
+ ## Debug Logging
113
+
114
+ Set the log level to see WebSocket traffic:
115
+
116
+ ```bash
117
+ export SIGNALWIRE_LOG_LEVEL=debug
118
+ ```
119
+
120
+ ## Async Context Manager
121
+
122
+ For use within an existing async application:
123
+
124
+ ```python
125
+ async with RelayClient(contexts=["default"]) as client:
126
+ call = await client.dial([...])
127
+ await call.answer()
128
+ ```
129
+
130
+ ## Next Steps
131
+
132
+ - [Call Methods Reference](call-methods.md) -- all methods available on a Call object
133
+ - [Events](events.md) -- handling real-time call events
134
+ - [Client Reference](client-reference.md) -- RelayClient configuration and methods
@@ -0,0 +1,306 @@
1
+ # RELAY Client Guide
2
+
3
+ The RELAY client provides real-time call and message control over a persistent WebSocket connection to SignalWire. Unlike the HTTP-based agent model (AgentBase), RELAY gives your application event-driven, bidirectional control of live calls and messages.
4
+
5
+ ## Authentication
6
+
7
+ ```typescript
8
+ import { RelayClient } from '@signalwire/sdk';
9
+
10
+ const client = new RelayClient({
11
+ project: 'your-project-id', // or env: SIGNALWIRE_PROJECT_ID
12
+ token: 'your-api-token', // or env: SIGNALWIRE_TOKEN
13
+ host: 'your-space.signalwire.com', // or env: SIGNALWIRE_SPACE
14
+ contexts: ['office', 'support'],
15
+ });
16
+ ```
17
+
18
+ All parameters can be provided via environment variables:
19
+ - `SIGNALWIRE_PROJECT_ID` - Your SignalWire project ID
20
+ - `SIGNALWIRE_TOKEN` - Your SignalWire API token (or `SIGNALWIRE_JWT_TOKEN` for JWT auth)
21
+ - `SIGNALWIRE_SPACE` - Your SignalWire space hostname
22
+
23
+ ## Handling Inbound Calls
24
+
25
+ ```typescript
26
+ client.onCall(async (call) => {
27
+ console.log(`Inbound call: ${call.callId}`);
28
+
29
+ await call.answer();
30
+
31
+ const action = await call.play([
32
+ { type: 'tts', text: 'Hello! Thanks for calling.' },
33
+ ]);
34
+ await action.wait();
35
+
36
+ await call.hangup();
37
+ });
38
+
39
+ // Start the client (auto-reconnects)
40
+ client.run();
41
+ ```
42
+
43
+ ## Making Outbound Calls
44
+
45
+ ```typescript
46
+ await client.connect();
47
+
48
+ const call = await client.dial(
49
+ [[{ type: 'phone', to: '+15551234567', from: '+15559876543' }]],
50
+ { dialTimeout: 30_000 },
51
+ );
52
+
53
+ console.log(`Call answered: ${call.callId}`);
54
+ await call.play([{ type: 'tts', text: 'Hello from RELAY!' }]);
55
+ await call.hangup();
56
+ ```
57
+
58
+ ### Dial Gotcha
59
+
60
+ The `calling.dial` RPC response does **not** contain a `call_id` — it only returns `{"code":"200","message":"Dialing"}`. The real `call_id` arrives via a `calling.call.dial` event matched by `tag`. The `dial()` method handles this automatically and returns a fully-initialized `Call` object.
61
+
62
+ ## Call Methods
63
+
64
+ ### Lifecycle
65
+ - `call.answer()` - Answer an inbound call
66
+ - `call.hangup(reason?)` - End the call
67
+ - `call.pass()` - Decline control, return to routing
68
+
69
+ ### Audio Playback
70
+ ```typescript
71
+ const action = await call.play([
72
+ { type: 'tts', text: 'Hello world', language: 'en-US' },
73
+ { type: 'audio', url: 'https://example.com/greeting.mp3' },
74
+ { type: 'silence', duration: 2 },
75
+ ]);
76
+
77
+ // Control playback
78
+ await action.pause();
79
+ await action.resume();
80
+ await action.volume(-3);
81
+ await action.stop();
82
+
83
+ // Or wait for completion
84
+ const event = await action.wait();
85
+ ```
86
+
87
+ ### Recording
88
+ ```typescript
89
+ const action = await call.record({ format: 'mp3' });
90
+ // ... later
91
+ await action.stop();
92
+ const event = await action.wait();
93
+ console.log(`Recording URL: ${event.url}`);
94
+ ```
95
+
96
+ ### Input Collection
97
+ ```typescript
98
+ // Play and collect (combined)
99
+ const action = await call.playAndCollect(
100
+ [{ type: 'tts', text: 'Enter your PIN:' }],
101
+ { digits: { max: 4, terminators: '#' } },
102
+ );
103
+ const event = await action.wait();
104
+
105
+ // Standalone collect (no media)
106
+ const collectAction = await call.collect({
107
+ speech: { endSilenceTimeout: 2 },
108
+ });
109
+ ```
110
+
111
+ ### Detection
112
+ ```typescript
113
+ const action = await call.detect(
114
+ { type: 'machine', params: { initial_timeout: 5 } },
115
+ { timeout: 10 },
116
+ );
117
+ const event = await action.wait();
118
+ // DetectAction resolves on first meaningful result (HUMAN, MACHINE, etc.)
119
+ ```
120
+
121
+ ### Connectivity
122
+ - `call.connect(devices, options?)` - Bridge to another endpoint
123
+ - `call.disconnect()` - Unbridge a connected call
124
+ - `call.transfer(dest)` - Transfer to another app/script
125
+ - `call.refer(device, options?)` - SIP REFER transfer
126
+
127
+ ### Other Methods
128
+ - `call.sendDigits(digits)` - Send DTMF
129
+ - `call.hold()` / `call.unhold()`
130
+ - `call.denoise()` / `call.denoiseStop()`
131
+ - `call.joinConference(name, options?)` / `call.leaveConference(id)`
132
+ - `call.stream(url, options?)` - Stream audio to WebSocket
133
+ - `call.tap(tap, device, options?)` - Media interception
134
+ - `call.transcribe(options?)` - Start transcription
135
+ - `call.pay(connectorUrl, options?)` - Payment collection
136
+ - `call.sendFax(document, options?)` / `call.receiveFax(options?)`
137
+ - `call.ai(options?)` - Start AI agent session
138
+ - `call.queueEnter(name)` / `call.queueLeave(name)`
139
+ - `call.echo()` - Echo audio back (testing)
140
+
141
+ ## Actions
142
+
143
+ Action methods return Action objects that track the operation's lifecycle:
144
+
145
+ ```typescript
146
+ const action = await call.play([{ type: 'tts', text: 'Hello' }]);
147
+
148
+ // Check status
149
+ console.log(action.isDone); // false
150
+ console.log(action.completed); // false
151
+
152
+ // Wait for completion
153
+ const event = await action.wait(10_000); // with timeout
154
+
155
+ // Or fire-and-forget with callback
156
+ await call.play(
157
+ [{ type: 'tts', text: 'Background music' }],
158
+ {
159
+ onCompleted: (event) => console.log('Playback finished'),
160
+ },
161
+ );
162
+ ```
163
+
164
+ ### Action Types
165
+ | Action | Methods | Terminal States |
166
+ |--------|---------|----------------|
167
+ | `PlayAction` | stop, pause, resume, volume | finished, error |
168
+ | `RecordAction` | stop, pause, resume | finished, no_input |
169
+ | `DetectAction` | stop | finished, error (+ first result) |
170
+ | `CollectAction` | stop, volume, startInputTimers | finished, error, no_input, no_match |
171
+ | `FaxAction` | stop | finished, error |
172
+ | `TapAction` | stop | finished |
173
+ | `StreamAction` | stop | finished |
174
+ | `PayAction` | stop | finished, error |
175
+ | `TranscribeAction` | stop | finished |
176
+ | `AIAction` | stop | finished, error |
177
+
178
+ ## Event Listening
179
+
180
+ ```typescript
181
+ // Listen for specific events on a call
182
+ call.on('calling.call.play', (event) => {
183
+ console.log(`Play state: ${event.params.state}`);
184
+ });
185
+
186
+ // Wait for a specific event
187
+ const event = await call.waitFor('calling.call.state',
188
+ (e) => e.params.call_state === 'answered',
189
+ 10_000, // timeout
190
+ );
191
+
192
+ // Wait for call to end
193
+ const endEvent = await call.waitForEnded(60_000);
194
+ ```
195
+
196
+ ## Messaging
197
+
198
+ ```typescript
199
+ // Send SMS
200
+ const message = await client.sendMessage({
201
+ to: '+15551234567',
202
+ from: '+15559876543',
203
+ body: 'Hello from RELAY!',
204
+ });
205
+
206
+ // Track delivery
207
+ const event = await message.wait(30_000);
208
+ console.log(`State: ${message.state}`); // delivered, undelivered, failed
209
+
210
+ // Receive inbound messages
211
+ client.onMessage(async (message) => {
212
+ console.log(`From ${message.fromNumber}: ${message.body}`);
213
+ });
214
+ ```
215
+
216
+ ## Reconnection
217
+
218
+ The `run()` method handles auto-reconnection with exponential backoff:
219
+
220
+ ```typescript
221
+ client.run(); // Blocks, auto-reconnects on disconnect
222
+ ```
223
+
224
+ Reconnection behavior:
225
+ - Initial delay: 1 second
226
+ - Max delay: 30 seconds
227
+ - Backoff factor: 2x
228
+ - Protocol/authorization state preserved across reconnects
229
+ - Queued requests flushed after re-authentication
230
+ - SIGINT/SIGTERM triggers clean shutdown
231
+
232
+ For manual control:
233
+ ```typescript
234
+ await client.connect();
235
+ // ... use client
236
+ await client.disconnect();
237
+ ```
238
+
239
+ ## Dynamic Context Subscription
240
+
241
+ ```typescript
242
+ await client.connect();
243
+
244
+ // Subscribe to new contexts at runtime
245
+ await client.receive(['sales', 'support']);
246
+
247
+ // Unsubscribe
248
+ await client.unreceive(['sales']);
249
+ ```
250
+
251
+ ## Error Handling
252
+
253
+ ```typescript
254
+ import { RelayError } from '@signalwire/sdk';
255
+
256
+ try {
257
+ await call.answer();
258
+ } catch (err) {
259
+ if (err instanceof RelayError) {
260
+ console.error(`RELAY error ${err.code}: ${err.message}`);
261
+ }
262
+ }
263
+ ```
264
+
265
+ ### Call-Gone Handling
266
+
267
+ When a call ends (404/410 from server), methods return `{}` instead of throwing. Actions are resolved immediately so `await action.wait()` doesn't hang:
268
+
269
+ ```typescript
270
+ const action = await call.play([{ type: 'tts', text: 'hello' }]);
271
+ // If call ended between play request and response, action.isDone === true
272
+ ```
273
+
274
+ ## Typed Events
275
+
276
+ All events are parsed into typed classes:
277
+
278
+ ```typescript
279
+ import { CallStateEvent, PlayEvent, parseEvent } from '@signalwire/sdk';
280
+
281
+ call.on('calling.call.state', (event) => {
282
+ const stateEvent = event as CallStateEvent;
283
+ console.log(stateEvent.callState); // 'answered', 'ended', etc.
284
+ console.log(stateEvent.endReason); // 'hangup', 'busy', etc.
285
+ });
286
+ ```
287
+
288
+ 22 typed event classes are available for all RELAY event types.
289
+
290
+ ## Environment Variables
291
+
292
+ | Variable | Purpose |
293
+ |----------|---------|
294
+ | `SIGNALWIRE_PROJECT_ID` | Project ID for authentication |
295
+ | `SIGNALWIRE_TOKEN` | API token for authentication |
296
+ | `SIGNALWIRE_JWT_TOKEN` | JWT token (alternative to project/token) |
297
+ | `SIGNALWIRE_SPACE` | Space hostname (default: relay.signalwire.com) |
298
+ | `SIGNALWIRE_LOG_LEVEL` | Log level: debug, info, warn, error |
299
+ | `SIGNALWIRE_LOG_MODE` | Set to "off" to suppress logging |
300
+
301
+ ## Examples
302
+
303
+ See the `examples/` directory:
304
+ - `relay-inbound.ts` - Answer calls, play TTS, collect digits
305
+ - `relay-outbound.ts` - Dial outbound, detect machine, play message
306
+ - `relay-messaging.ts` - Send/receive SMS