Navigators

Navigators allow you to send a message via the best of multiple channels.

Navigator behaviour may vary according to the country you are sending to and the message type. You can see the preferred kind of SMS channels for each scenario here and check any existing navigator in your workspace via the Navigator TAB in the developer dashboard

Navigators are in early-release and currently only work for SMS channels

List Available Navigators

By default, each workspace will have 3 navigators.

  • Marketing: The primary objective of marketing navigators is to send bulk traffic. They will only attempt delivery via PROMOTIONAL channels, adhering to the strictest compliance checks, including quiet hours and Opt-Out regulations.

  • Conversation: Conversational navigators consider only two-way channels, ignoring any one-way channels (such as those using Alphanumeric senders).

  • Transactional: The transactional navigator prioritizes high-quality routes when applying only the minimum required compline check. Transactional navigators will never send traffic from a non-transactional channel (ex, a promotional one) to ensure the best possible Quality of Service.

  • OTP: The 2FA navigator prioritizes deliverability above all. It attempts to send messages via 2FA channels first but will use transactional channels if none are available, and as a last resort, it will utilize promotional channels.

When sending OTPs, ensure you have either 2FA or transactional channels in your workspace. OTP messages delivered through promotional channels during quiet hours may be delayed until the following day.

Inspect a Navigator

Create a Customize Navigator

If you want to limit the selection of channels a navigator can access, you can create a customized one.

Coverage

Navigators can access as many countries as there are channels available to them. Coverage may vary over time based on channel availability and health.

Sending messages

A-Sync : this will start a background process that may require some time to complete. A Get call may be required to to retrieve the final result .

The Navigators POST request follows the same schema and requires the same body as the channels POST request

The navigator message will contain navigator metadata, including.

Navigator information

providing UUID relevant to both the navigator objection and the navigator message objects

    "meta": {
        "navigatorId": "5f40c7f0-5904-4d68-8840-a1a5dc3e36c3",
        "navigatorMessageId": "5ec65d4f-53b0-45f8-8f83-b177f976b3e3"
    },

Attempts

Navigator may attempt to send messages via more than one channel. attempts will list and providing information about all channels a navigator used when handling a given message

    "navigatorData": {
        "attempts": [
            {
                "channelId": "6f50cd25-d416-44d3-bf63-de88a60129d0",
                "messageId": "3ecadc0d-cf7c-4b2a-90bc-fed5a3f6a26e",
                "attempt": 1,
                "status": "accepted",
                "createdAt": "2024-07-18T14:04:18.214Z"
            }

You can get messages sent to a navigator by making a request to the channel endpoint that accepted the message based on the response above

Update a Navigator

Delete a Navigator

Last updated