Skip to content

Commit feb2713

Browse files
Merge pull request #16 from photon-hq/docs/update-spectrum-ts-v1.4.0
docs: update spectrum-ts documentation for v1.4.0
2 parents 6622de2 + e5657a6 commit feb2713

3 files changed

Lines changed: 13 additions & 10 deletions

File tree

docs-src/spectrum-ts/providers/imessage.mdx.vel

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,11 +66,10 @@ Cloud mode routes your messages through phone numbers ("lines") provisioned by S
6666
| **Business** | **Dedicated.** All of your end users text the same number, which belongs to your project. | A normal iMessage, always from the same number. |
6767

6868
End-user delivery is identical in both modes; the distinction is which number sends.
69-
Cloud mode routes your messages through dedicated phone numbers ("lines") provisioned by Spectrum. Each project gets one or more dedicated lines, and all your end users text the same number(s).
7069

7170
### Auto-scale
7271

73-
When traffic to a dedicated line approaches its per-line capacity, Spectrum can automatically provision an additional line so deliverability isn't affected. It's an opt-in feature on the Business plan. Enable it in your project settings if you'd rather not get paged when a line saturates.
72+
When traffic to a dedicated line approaches its per-line capacity, Spectrum can automatically provision an additional line so deliverability isn't affected. Auto-scale is an opt-in feature on the Business plan. Enable it in your project settings if you'd rather not get paged when a line saturates.
7473

7574
<Note>
7675
These are managed Spectrum Cloud features. If you're on the open-source path (`imessage.config({ local: true })` or your own dedicated relay), you provide your own iCloud account and managed-line concepts don't apply.
@@ -113,13 +112,17 @@ Space creation requires cloud or dedicated mode. In local mode `space()` throws
113112

114113
### Per-phone routing
115114

116-
If your account has multiple phone numbers, you can pin a conversation to a specific line by passing `phone` as a space parameter:
115+
If your account has multiple dedicated phone numbers, you can pin a conversation to a specific line by passing `phone` as a space parameter:
117116

118117
```ts
119118
const dm = await im.space(alice, { phone: "+15559999999" });
120119
```
121120

122-
When omitted, Spectrum picks a phone at random from the available lines. All subsequent actions on that space — sending, typing, replies, edits, reactions, and lookups — route through the chosen number.
121+
When omitted, Spectrum picks a phone at random from the available dedicated lines. All subsequent actions on that space — sending, typing, replies, edits, reactions, and lookups — route through the chosen number.
122+
123+
<Note>
124+
Per-phone routing applies to dedicated lines (Business plan) only. On shared-pool plans the `phone` parameter is ignored — all conversations route through the shared pool automatically.
125+
</Note>
123126

124127
## Tapback constants
125128

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
"eslint-plugin-format": "^2.0.1",
2828
"husky": "^9.1.7",
2929
"oxfmt": "^0.44.0",
30-
"spectrum-ts": "1.2.1",
30+
"spectrum-ts": "1.4.0",
3131
"tsx": "^4.21.0",
3232
"typescript": "^5.9.3"
3333
}

pnpm-lock.yaml

Lines changed: 5 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)