Mobile-X

    Create Mobile-X Messaging Gateway

    The VoIP Help Page Team·3 min read·Last updated: March 14, 2026

    This article provides a step-by-step guide on how to create and configure a messaging gateway for a group within Mobile-X, including creating an API user, setting up an OAuth client, and assigning the default gateway. Messaging Gateways are essential for sending and receiving text messages via Mobile-X.

    Scope

    This article outlines how to create a messaging gateway for a group in Mobile-X. Messaging Gateways are required in order to send and receive text messages.

    Requirements

    • Access to Mobile-X Control Panel
    • PBX Domain of Client
    • Access to NMS
    • Access to Hudu
    • Mobile-X API Username and Password
    • Mobile-X Client ID and Secret

    Create Mobile-X API User

    1. 1
      Log in to NMS
    2. 2
      Navigate to Users > Configuration

    3. Filter for the client's domain and click Add User

    4. Complete the following fields, leaving all others default 1. User Name: mobilex 2. First Name: Mobile-X 3. Last Name: API User 4. Login Name: mobilex@<domain name> 5. New Portal/API Password: Generate a secure password at least 20 characters long. Special characters should only be !, ?, or $. Make sure this is documented for later. 6. Scope: Reseller 7. Service Code: (system-user) Generic System User 8. Create User Device: No 5. Click Create


    Create OAuth Client ID and Secret

    This step should only be completed once per reseller. For resellers with existing clients, use the Client ID and Secret for Mobile-X documented in Hudu

    1. 1
      Log in to NMS
    2. 2
      Navigate to System > Settings > Advanced > Oauth Clients

    3. Click Add

    4. Set the Client ID to mobilex@<resellerID>.service and click Create

    5. Document the new Client ID and Secret under the company in Hudu with the name Mobile-X Client ID and Secret


    Create Messaging Gateway

    1. 1
      Log in to Mobile-X
    2. 2
      Navigate to the group you are configuring

    NOTE: This should always be done on a group, not a reseller or distributor endpoint

    1. 1

      Select Endpoints > Messaging Gateway

    2. 2

      Click + New Gateway

    5. Complete the following fields: 1. Name: Enter the client's domain name, using underscores in place of periods (i.e., niftywidgets_99999_service) 2. Server Type: Netsapiens R41 3. Country: United States (US) 4. URL: https://api.ucaasnetwork.com/ns-api 5. Secondary URL: https://sbc.ucaasnetwork.com/ns-api 6. Login: Enter the username for the API User 7. Password: Enter the password for the API User 8. Client ID: Enter the Mobile-X Client ID 9. Client Secret: Enter the Mobile-X Client Secret 6. Click Save


    Set Default Messaging Gateway

    1. 1

      Log in to Mobile-X

    2. 2

      Navigate to the group you are configuring

    3. 3

      Select Endpoints > Edit Endpoint Settings

    4. 4

      Set the Default Messaging Gateway to the newly created gateway and click Save

    Was this article helpful?