Search all guides
Documentation / Getting Started
Configure the endpoint and calling policy
The administrator chooses the authorisation service. There is no hidden default provider.
Use the complete HTTPS URL
Save the operator-supplied endpoint in Connectivity > DOMAINTAINS or use the endpoint command. The module sends its activation request to exactly that URL; it does not append a path. Embedded credentials, fragments, whitespace and malformed URL encoding are rejected. Never place tokens in the URL.
fwconsole domaintains endpoint https://control.example.invalid/activate
fwconsole domaintains endpoint --jsonChoose routing deliberately
Fresh neutral installations require an explicit outbound pattern array before activation. There is no built-in national, emergency or catch-all dialling policy. Validate permissions on both the PBX and the outbound edge. Existing legacy policy is retained; changes to protected existing routes require ownership review.
Synthetic example only
The endpoint below is deliberately non-operational. Replace it with the complete endpoint supplied by your operator. The routing example in the BYOT repository is restricted to documentation numbers and must not be adopted as a real calling policy.
Endpoint and policy checks
| Check | Required behaviour |
|---|---|
| Complete URL | Use the activation endpoint itself. DOMAINTAINS does not append /activate or infer another path. |
| Transport | HTTPS with a valid DNS hostname and certificate verification. Do not embed credentials or tokens. |
| Neutral routing | An explicit array of supported FreePBX route patterns is required before first activation. No emergency or catch-all policy is supplied. |
| Retained configuration | Existing legacy routes are preserved. Protected routing changes require ownership review, not silent replacement. |
Read configuration without supplying a token
fwconsole domaintains endpoint --json
fwconsole domaintains identity --json
fwconsole domaintains status --json