• Home
  • Hardware & Software
  • Mobile-X

Create Mobile-X Messaging Gateway

Written by Marissa Orsini

Updated at May 6th, 2025

Contact Us

  • The Essentials
    FAQs Forms
  • Announcements
    Carrier Events mFax Events Platform Events Release Notes
  • Billing Administration
    Datagate OneBill
  • Faxing
    mFax - Analog mFax - Digital Native Fax
  • Hardware & Software
    Manual Configuration Provisioning NDP Axis Cisco Fanvil Grandstream Polycom Snom Yealink Mobile Applications Desktop Applications Mobile-X SNAPbuilder TeamMate Connector UC Integrator
  • Hosted Voice
    Auto Attendants Branding Call Queues Call Routing CDRs Conferencing E-911 Features Fraud Integrations Inventory / Phone Numbers Local & Toll Free Porting Onboarding Recommendations SNAP.HD SIP Trunking SMS / MMS Users Voicemail Caller ID
  • Troubleshooting
    VoIPmonitor Firewalls PBX
  • Ray's Stuff
+ More

Table of Contents

Create Mobile-X API User Create OAuth Client ID and Secret Create Messaging Gateway Set Default Messaging Gateway

Scope

Intended Audience: CS Department and WLP

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. Log in to NMS
  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. Log in to NMS
  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. Log in to Mobile-X
  2. Navigate to the group you are configuring
    NOTE: This should always be done on a group, not a reseller or distributor endpoint
  3. Select Endpoints > Messaging Gateway
  4. Click + New Gateway
  5. Complete the following fields:
    1. Name: Enter the client's domain name, using underscores in place of periods (ie 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. Log in to Mobile-X
  2. Navigate to the group you are configuring
  3. Select Endpoints > Edit Endpoint Settings
  4. Set the Default Messaging Gateway to the newly created gateway and click Save
messaging mobile-x

Was this article helpful?

Yes
No
Give feedback about this article

Related Articles

  • Mobile-X Direct VoLTE Migration
  • Considerations for Mobile-X
  • Create Mobile-X Group
  • Import Phone Numbers to Mobile-X

Knowledge Base Software powered by Helpjuice

Expand