Skip to content

Commit caf53ab

Browse files
authored
Merge branch 'main' into diego/13616/align-laml-vs-cxml-docs
2 parents 0449a86 + 39bed0e commit caf53ab

File tree

27 files changed

+741
-178
lines changed

27 files changed

+741
-178
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
name: API Documentation Handoff from Prime to DevEx
3+
about: Formal handoff from the Prime team to DevEx for finalizing and publishing API documentation updates.
4+
title: "[Prime Documentation Handoff] <Short Description of Change>"
5+
labels: team/developer-experience, area/rest-api, status/needs-triage
6+
assignees: ''
7+
8+
---
9+
10+
## Ticket & PR References
11+
- **Internal Ticket:** references [ticket]
12+
- **API PR:** references [open PR]
13+
14+
---
15+
16+
## Background
17+
18+
**Summary of Change:**
19+
Briefly explain what was added, changed, or removed in the API and why.
20+
21+
**Deployment Timing:**
22+
When are the changes expected to go live?
23+
24+
**Breaking Change:**
25+
Is this a breaking change? If so, what is the impact and how should it be communicated?
26+
27+
---
28+
29+
## Handoff Checklist
30+
31+
- [ ] API changes have been reviewed and approved by the Prime team.
32+
- [ ] TypeSpec/documentation builds successfully.
33+
- [ ] Preview looks correct and matches expectations.
34+
35+
<details>
36+
<summary>Additional context (if any of the above items are unchecked)</summary>
37+
38+
<!-- Add details here if there are known issues, blockers, or questions related to the docs. -->
39+
40+
</details>
41+
42+
---
43+
44+
## Next Steps
45+
46+
- [ ] Prime will monitor this ticket for any follow-up questions or issues.
47+
- [ ] DevEx can proceed with documentation adjustments, merging, and publishing when ready.
48+
49+
<!-- Add any relevant context or expectations around timing, testing, or coordination.
50+
If documentation should not be merged immediately — for example, if it depends on a specific deployment date or another task being completed first — please include those details here. -->
51+
52+
53+

config/includedScripts.ts

+3-13
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@
77
* Docusaurus technical reference: https://docusaurus.io/docs/api/docusaurus-config#scripts
88
*/
99

10-
import type { Config } from '@docusaurus/types';
10+
import type { Config } from "@docusaurus/types";
1111

12-
type ScriptItem = NonNullable<Config['scripts']>[number];
12+
type ScriptItem = NonNullable<Config["scripts"]>[number];
1313

1414
const scripts: ScriptItem[] = [
1515
{
@@ -27,21 +27,11 @@ const scripts: ScriptItem[] = [
2727
async: true,
2828
nonce: "SIGNALWIRE_DOCS_CSP_NONCE",
2929
},
30-
{
31-
src: "/scripts/munchkin.js",
32-
async: true,
33-
nonce: "SIGNALWIRE_DOCS_CSP_NONCE",
34-
},
35-
{
36-
src: "/scripts/zendesk.js",
37-
async: true,
38-
nonce: "SIGNALWIRE_DOCS_CSP_NONCE",
39-
},
4030
{
4131
src: "/scripts/hubspot.js",
4232
async: true,
4333
nonce: "SIGNALWIRE_DOCS_CSP_NONCE",
4434
},
4535
];
4636

47-
export default scripts;
37+
export default scripts;

config/navbar.ts

+24-5
Original file line numberDiff line numberDiff line change
@@ -167,14 +167,14 @@ const navbar: NavbarItem[] = [
167167
position: "right",
168168
items: [
169169
{
170-
href: "https://support.signalwire.com",
171-
label: "Contact Support",
170+
href: "https://signalwire.zohodesk.com/portal/en/newticket",
171+
label: "Create a Ticket",
172172
"aria-label": "Support",
173173
},
174174
{
175-
href: "https://discord.com/invite/F2WNYTNjuF",
176-
label: "Discord",
177-
"aria-label": "Discord Community",
175+
href: "https://signalwire.zohodesk.com/portal/en/myarea",
176+
label: "My Tickets",
177+
"aria-label": "Support",
178178
},
179179
{
180180
href: "https://status.signalwire.com",
@@ -184,6 +184,25 @@ const navbar: NavbarItem[] = [
184184
],
185185
},
186186

187+
/// Community Dropdown -------- ///
188+
{
189+
type: "dropdown",
190+
label: "Community",
191+
position: "right",
192+
items: [
193+
{
194+
href: "https://signalwire.zohodesk.com/portal/en/community",
195+
label: "Community Forum",
196+
"aria-label": "Community forum",
197+
},
198+
{
199+
href: "https://discord.com/invite/F2WNYTNjuF",
200+
label: "Discord Server",
201+
"aria-label": "Discord server",
202+
},
203+
],
204+
},
205+
187206
{
188207
href: "https://signalwire.com/signin",
189208
label: "Dashboard",

docs/home/messaging/sms/_usecases/_usecases.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -13,23 +13,23 @@ import SmsRelayForward from "./_Sms/_Forward/_Relay.mdx"
1313
import SmsCxmlForward from "./_Sms/_Forward/_Cxml.mdx"
1414

1515
<UseCaseView data={{
16-
"Send a SMS Message": {
16+
"Send an SMS message": {
1717
"SWML": <SmsSwml/>,
1818
"Relay Realtime SDK (Server)": <SmsRelay/>,
1919
"CXML": <SmsCxml/>,
2020
"REST API": <SmsRest/>
2121
},
22-
"Send a MMS Message": {
22+
"Send an MMS message": {
2323
"SWML": <MmsSwml/>,
2424
"Relay Realtime SDK (Server)": <MmsRelay/>,
2525
"CXML": <MmsCxml/>,
2626
"REST API": <MmsRest/>
2727
},
28-
"Respond to a Incoming Message": {
28+
"Respond to an incoming message": {
2929
"Relay Realtime SDK (Server)": <SmsRelayRespond/>,
3030
"CXML": <SmsCxmlRespond/>
3131
},
32-
"Forward a Incoming Message": {
32+
"Forward an incoming message": {
3333
"Relay Realtime SDK (Server)": <SmsRelayForward/>,
3434
"CXML": <SmsCxmlForward/>
3535
}
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Toll-Free Verification
2+
title: Toll-free verification
33
slug: /messaging/guides/general/toll-free-number-overview
44
sidebar_position: 4
55
x-custom:
@@ -9,51 +9,77 @@ x-custom:
99
description: Overview of Toll-Free number verification process.
1010
---
1111

12-
## Toll-Free Number Overview
12+
import { MdContactPhone } from "react-icons/md";
1313

14-
A great alternative to using a Short Code or a 10DLC (local area code) number is a Toll-Free number. Toll-Free US numbers can be used for business messaging to all major US carriers, as well as most major mobile Canadian carriers.
14+
## Overview
1515

16-
:::info
16+
<div className="row">
17+
18+
<div className="col col--8">
1719

18-
A no-cost
19-
[verification](https://support.signalwire.com/hc/en-us/requests/new?ticket_form_id=13501768371227)
20-
process needs to be completed for all Toll-Free numbers before being permitted
21-
to send any messages. Pending and unverified numbers are no longer be able to freely send messages.
20+
Toll-free numbers are a great alternative to messaging with Short Code or 10DLC (local area code) numbers.
21+
In the US, toll-free numbers can be used for business messaging to all major US carriers, as well as most major mobile Canadian carriers.
22+
23+
:::info
2224

23-
:::
25+
All toll-free numbers must be verified prior to sending messages.
2426

25-
As a rule of thumb, some [categories of messaging are forbidden](/messaging/getting-started/sms-best-practices-how-to-ensure-message-delivery) on SignalWire. Please take the time to review our list of explicitly prohibited content before submitting your application for Toll-Free, 10DLC, and Short Code.
27+
:::
28+
</div>
29+
30+
<div className="col col--4">
31+
<Card
32+
title="Toll-free verification form"
33+
href="https://forms.signalwire.me/Toll-Free-Verifications.html"
34+
icon={<MdContactPhone />}
35+
>
36+
Submit this form to begin the verification process for a new toll-free number.
37+
</Card>
38+
</div>
39+
40+
</div>
2641

27-
Downstream message filtering is designed to prevent unwanted messaging, fraud, and abuse. Before considering verifying your Toll-Free number, please be sure to follow the [CTIA guidelines and best messaging practices](https://api.ctia.org/wp-content/uploads/2023/05/230523-CTIA-Messaging-Principles-and-Best-Practices-FINAL.pdf).
2842

29-
The following standards must be followed for Toll-Free messaging:
43+
As a rule of thumb, some [categories of messaging are forbidden](/messaging/getting-started/sms-best-practices-how-to-ensure-message-delivery) on SignalWire.
44+
Please take the time to review our list of explicitly prohibited content before submitting your application for Toll-Free, 10DLC, and Short Code.
3045

31-
- Obtain clear opt-in consent from your recipients before sending messages
32-
- Provide an easy way for your recipients to opt-out of receiving messages
33-
- Avoid using shortened URLs. It's highly recommended to use a full branded URL as well as URLs that lead back to a legitimate website that contains branding, a privacy policy, terms of service, and contact information. Publicly hosted URL shorteners are forbidden and are guaranteed to cause spam blocks
34-
- Using multiple Toll-Free numbers to send the same or similar content to bypass throughput limitations is known as **snowshoeing**. This is **highly prohibited** by carriers. If you need to [increase your throughput](https://signalwire.com/products/cloud-messaging/high-throughput-messaging#:~:text=With%20SignalWire%20High-Throughput%20Messaging,with%20Toll-Free%20numbers%20only), it can be approved by our Sales team. If you have a valid use case for using multiple Toll-Free numbers (such as multiple locations all requiring an individual Toll-Free number), this is something we may be able to work out with our carriers.
46+
Downstream message filtering is designed to prevent unwanted messaging, fraud, and abuse.
47+
Before considering verifying your Toll-Free number, please be sure to follow the
48+
[CTIA guidelines and best messaging practices](https://api.ctia.org/wp-content/uploads/2023/05/230523-CTIA-Messaging-Principles-and-Best-Practices-FINAL.pdf).
3549

36-
## Get Verified!
50+
### Requirements
3751

38-
### What is Toll-Free Verification?
52+
The following standards must be followed for Toll-Free messaging:
3953

40-
Getting your Toll-Free number verified means that your business and use case has been reviewed and vetted prior to sending messaging via Toll-Free and that your content has received carrier approval.
54+
- **Obtain clear opt-in consent** from your recipients before sending messages
55+
- **Enable easy opt-out** for message recipients
56+
- **Avoid using shortened URLs**
57+
- It's highly recommended to use a full branded URL as well as URLs that lead back to a legitimate website that contains branding, a privacy policy, terms of service, and contact information.
58+
Publicly hosted URL shorteners are forbidden and are guaranteed to cause spam blocks.
59+
- Using multiple Toll-Free numbers to send the same or similar content to bypass throughput limitations is known as **snowshoeing**. This is **highly prohibited** by carriers. If you need to [increase your throughput](https://signalwire.com/products/cloud-messaging/high-throughput-messaging#:~:text=With%20SignalWire%20High-Throughput%20Messaging,with%20Toll-Free%20numbers%20only), it can be approved by our Sales team. If you have a valid use case for using multiple Toll-Free numbers (such as multiple locations all requiring an individual Toll-Free number), this is something we may be able to work out with our carriers.
4160

42-
:::info
61+
## Verification process {#get-verified}
4362

44-
Please note that the verification process is free of charge.
63+
Getting your Toll-Free number verified means that your business and use case has been reviewed and vetted prior to sending messaging via Toll-Free and that your content has received carrier approval.
4564

46-
:::
65+
There is no charge associated with the verification process.
4766

48-
Having your Toll-Free numbers verified will greatly reduce the risk of spam filtering on Toll-Free traffic towards all major mobile carriers in the US, as well as most major mobile carriers in Canada, so long as you stick with the content you submitted for verification and continue to follow SignalWire's [messaging best practices](https://signalwire.com/resources/guides/a2p-messaging-use-case-best-practices) and [code of conduct](https://signalwire.com/legal/messaging-code-of-conduct). Deviation from your verification registration can still result in spam filtering. **Verified does not mean whitelisted.**
67+
Having your Toll-Free numbers verified will greatly reduce the risk of spam filtering on Toll-Free traffic towards all major mobile carriers in the US, as well as most major mobile carriers in Canada.
68+
Make sure you stick to the content you submitted for verification and continue to follow SignalWire's
69+
[messaging best practices](https://signalwire.com/resources/guides/a2p-messaging-use-case-best-practices) and
70+
[code of conduct](https://signalwire.com/legal/messaging-code-of-conduct).
71+
Deviation from your verification registration can still result in spam filtering. **Verified does not mean whitelisted.**
4972

5073
Verification affects messaging to mobile subscribers in the United States as well as Fido, Rogers, Telus, and Videotron in Canada.
5174

5275
Note: Other (non-US/Canada) countries do not treat Toll-Free SMS any differently than other international SMS, and you should consult that country's SMS Guidelines page to learn more about compliance considerations for messaging.
5376

5477
### Toll-Free Verification Process
5578

56-
If you believe you have a valid use case for a Toll-Free number, our Carrier Operations team would be happy to assist you with obtaining a [Toll-Free verification](https://support.signalwire.com/hc/en-us/requests/new?ticket_form_id=13501768371227). Once you fill out this [form](https://support.signalwire.com/hc/en-us/requests/new?ticket_form_id=13501768371227), a ticket will be generated for our Carrier Operations team to process. The turnaround for Toll-Free verification is 3-5 business days.
79+
If you believe you have a valid use case for a Toll-Free number, our Carrier Operations team would be happy to assist you.
80+
Once you fill out the [verification form](https://forms.signalwire.me/Toll-Free-Verifications.html),
81+
a ticket will be generated for our Carrier Operations team to process.
82+
The turnaround for Toll-Free verification is 3-5 business days.
5783

5884
:::caution
5985

@@ -76,41 +102,64 @@ The form linked above includes the following fields. All of this information is
76102

77103
:::info
78104

79-
Note: While it is not required to include samples of every different iteration of your messaging content, it is strongly recommended that the message samples you provide represent the majority of the content you plan on sending.
105+
Note: While it is not required to include samples of every different iteration of your messaging content,
106+
it is strongly recommended that the message samples you provide represent the majority of the content you plan on sending.
80107

81108
:::
82109

83110
## FAQs
84111

85-
### I have many Toll-Free customers under my account, can I verify in bulk?
112+
<AccordionGroup>
113+
114+
<Accordion title="I have many Toll-Free customers under my account, can I verify in bulk?">
115+
116+
If you are an ISV, for example, and need to complete verification for multiple customers/multiple numbers, please
117+
[download this template](https://docs.google.com/spreadsheets/d/1_LXQ1oXjybbB9YbdBQxfHuoBZIdyI2Bg/edit#gid=1315500553)
118+
and fill out the required information for each number.
119+
To download, click File > Download > Microsoft Excel (.xlsx).
120+
Once you're ready to submit, send the form to [email protected] and our Carrier Operations team will be in touch.
121+
122+
</Accordion>
123+
124+
<Accordion title="Is there an API available?">
125+
126+
No.
127+
128+
</Accordion>
129+
130+
<Accordion title="Does TCR (The Campaign Registry) process toll-free verifications?">
131+
132+
No, TCR is not involved with Toll-Free verifications.
133+
A specific Toll-Free Aggregator handles Toll-Free messaging for the industry and is unrelated to TCR.
134+
135+
</Accordion>
86136

87-
If you are an ISV, for example, and need to complete verification for multiple customers/multiple numbers, please [download this template](https://docs.google.com/spreadsheets/d/1_LXQ1oXjybbB9YbdBQxfHuoBZIdyI2Bg/edit#gid=1315500553) and fill out the required information for each number. To download, click File > Download > Microsoft Excel (.xlsx). Once you're ready to submit, send the form to [email protected] and our Carrier Operations team will be in touch with you!
137+
<Accordion title="Why does Canada have stricter requirements?">
88138

89-
### Is there an API available?
139+
Canada is more restrictive because of its anti-spam laws and the policies
140+
implemented by mobile carriers to meet the law.
90141

91-
Currently (as of March 2024), there is no API available for submitting Toll-Free verification requests.
142+
</Accordion>
92143

93-
### Does TCR (The Campaign Registry) process Toll-Free Verifications?
144+
<Accordion title="Is legal language required somewhere on the brand's website about messaging?">
94145

95-
No, TCR is not involved with Toll-Free verifications. A specific Toll-Free
96-
Aggregator handles Toll-Free messaging for the industry and is unrelated to TCR.
146+
Toll-Free Verification and the downstream provider require legal language to be found somewhere on the brand's website about messaging.
147+
You will have to provide a link to your company's terms and conditions and your privacy policy.
97148

98-
### Why does Canada have stricter requirements?
149+
</Accordion>
99150

100-
Canada is more restrictive because of its anti-spam laws and the policies
101-
implemented by mobile carriers to meet the law.
151+
<Accordion title="How long does the toll-free verification process take?">
102152

103-
### Is legal language required somewhere on the brand's website about messaging?
153+
It can take up to 2 weeks, from start to finish.
104154

105-
Toll-Free Verification and the downstream provider require legal language to be found somewhere on the brand's website about messaging. You will have to provide a link to your
106-
company's terms and conditions and your privacy policy.
155+
</Accordion>
107156

108-
### How long does it take for the Toll-Free verification process?
157+
<Accordion title="If my Toll-Free number is verified, does that guarantee deliverability?">
109158

110-
It can take up to 2 weeks, from start to finish.
159+
No, your verified Toll-Free number is subject to limited filtering.
160+
If your content is flagged as spam, that specific content will be blocked,
161+
but not the Toll-Free number.
111162

112-
### If my Toll-Free number is verified, does that guarantee deliverability?
163+
</Accordion>
113164

114-
No, your verified Toll-Free number is subject to limited filtering. If your
115-
content is flagged as spam, that specific content will be blocked, but not the
116-
Toll-Free number.
165+
</AccordionGroup>

0 commit comments

Comments
 (0)