Enable on pipelines & cloning
An active integration sends no traffic until BYO SMS is enabled for the pipeline. Complete Build an integration — not applicable to a managed Vodafone integration, which Akedly builds — and Test & activate first, then enable it for a pipeline — optionally cloning an integration for pipeline-specific coverage.
Managed Vodafone integrations differ
BYO SMS here describes an integration you build and own. If Akedly operates a managed Vodafone integration for your account, several of the capabilities described below are fixed by Akedly and are not yours to set — see Managed Vodafone.
Where to set it
Open an authentication pipeline in Authentication → Setup → Pipelines, then find BYO-SMS routing in its configuration panel. Utility pipelines live under Utilities → Pipelines and are gated by the same routing switch. Build and test the integration first — or, for a managed Vodafone integration, fill in the parts you own and get it past its readiness gates. Creating and cloning a managed integration are gated on pilot provisioning, not withheld from you: once Akedly has provisioned your account you do both yourself, and the fixed managed fields stay fixed in the copy.
Open a pipeline and configure its BYO-SMS routing.
If the pipeline editor shows no BYO-SMS routing section, your account does not have BYO SMS yet — arrange entitlement with Akedly.
Turn BYO SMS on for a pipeline
Under Routing mode, BYO-SMS for this pipeline has three modes that control whether this pipeline routes through BYO SMS.
| Control | Effect |
|---|---|
| Inherit from accountselect | Follow the account-wide default Akedly sets for you — the customer dashboard has no account-wide switch, so contact Akedly to change it. The card shows the resolved result, such as "Resolved: BYO-SMS on — Following your account default (on)." |
| On for this pipelineselect | Force BYO SMS on for just this pipeline — the self-serve way to enable it without an account change. |
| Off for this pipelineselect | Force BYO SMS off for this pipeline. OTP SMS uses Akedly's senders where available; utility SMS has no Akedly SMS route and fails when it requires BYO SMS. |
| Save changesbutton | Select Save changes to save the routing mode with the pipeline draft. |
Active is not the same as routing
Even a passing, active integration sends nothing until the pipeline resolves to BYO-SMS on — On for this pipeline, or Inherit from account while Akedly's account default is on — and an active integration covers the destination country.
How Akedly picks the integration
Use the read-only Effective routing preview to inspect the resolved route for a destination.
- Name
- Pipeline copy first
- Type
- precedence
- Description
An active integration cloned onto this pipeline wins over an active integration in your account registry.
- Name
- Specific country beats catch-all
- Type
- coverage
- Description
An active integration that lists the destination country wins over an active all-countries (catch-all) integration in the same scope.
- Name
- Otherwise Akedly
- Type
- fallback
- Description
For OTP, a destination no active integration covers falls back to Akedly's own SMS senders. When a utility send resolves to SMS, it has no Akedly SMS fallback and returns a BYO routing error when no integration covers it. See the Reference for request-chain failure behavior.
Within one scope, active integrations cannot overlap: each destination country belongs to at most one active integration, plus at most one catch-all. Akedly blocks activating a second integration that would claim a country already covered in the same scope.
Select a country in the preview to verify An SMS to [country] resolves where you expect. The preview does not change routing.
Cloning an integration onto a pipeline
Under Integrations on this pipeline, use Clone from your registry to create a pipeline-scoped copy.
| Control | Effect |
|---|---|
| Clone to this pipelinebutton | Create a pipeline-specific copy of the registry integration, including its coverage and stored credentials. Once active, the pipeline copy takes precedence over the registry when both cover the same destination country. |
| Independent copycopy-by-value | "Independent copies cloned from your registry — edits and tests here never touch the original." The reverse holds too: updating the registry does not change existing clones — re-clone to refresh from an updated source. |
| Draft → Livestatus | A fresh clone lands as Draft. It must pass its own activation test in its own pipeline scope, then be turned Live, before it can route. Follow the Test & activate process. |
| Own SMSbilling | The clone copies the source's integration settings, including any integration fee override. Its resolved Own SMS fee is shown on the card, for example "0.05 EGP / successful auth" (the default; an Akedly-set account or integration override may apply when no integration override is set). |
| Registry routingrouting | Cloning is optional. An active registry integration already routes for any pipeline that resolves to BYO-SMS on. Clone only when one pipeline needs a different integration, coverage, or credentials than your account-wide registry default. |
What's next
See the Reference for routing, failure behavior, billing, and dashboard errors.