TSGGLOBAL Support sign in
Skip to page content
Browse TSG Global API docs

TSG Global API documentation Staging Environment Access

Staging Environment Access

View page MarkdownAI documentation indexDownload OpenAPI
On this page

How to connect to the TSG Global staging environment over SMPP, MM4/SMTP and the HTTP APIs before moving to production.

Introduction

This document outlines the steps customers should take to onboard onto our staging environment, focusing on connecting using SMPP/SMTP and HTTP API protocols for both SMS and MMS messaging.

Disclaimers

Please be advised that you will be connecting to an active staging/testing environment hosted by TSG Global. There will be changes actively pushed to our staging environment that may occasionally break some features without warning. Additionally, to control costs, we do not scale our staging environment to the same degree as our production environment, so throughput may occasionally become an issue. We will work closely with your testing team in a dedicated Slack channel to ensure you have a robust testing experience that you are happy with prior to migrating to production.

Prerequisites

Before connecting to our staging environment:

  1. Ensure that you have valid credentials provided by our support team.
  2. Ensure that you have joined the Slack channel set up with your team to assist you with any technical questions you may have during testing.
  3. Set up a testing machine or environment on your end.
  4. Familiarize yourself with the SMPP protocol and HTTP API concepts if you haven't already.
  5. Review the TSG Global API documents located at: https://support.tsgglobal.com/docs/index.md, starting with the API Quick Reference.

SMS via SMPP

Configuration Details

  • SMPP Host: smsc.staging.tsgglobal.com
  • SMPP Port: 2775 for TCP or 2776 for TLS connections
  • Bind type: Transceiver
  • System ID: Provided by our support team.
  • Password: Provided by our support team.

Steps to Connect

  1. Install an SMPP client or library compatible with your system.
  2. Configure the SMPP client using the provided configuration details.
  3. Connect to the staging SMPP server.
  4. Test by sending and receiving SMS messages.
  5. Review the sample delivery reports and error messages (if any) for troubleshooting.
  6. For any additional information please refer to SMPP.

Sending SMS via HTTP API

Endpoint Information

  • Base URL: https://sms-api.staging.tsgglobal.com
  • Endpoint: see Send an SMS Message
  • Authentication key: provided by our support team.

Steps to Connect

  1. Configure the HTTP client or tool you will use for testing (e.g. Postman, curl).
  2. Set the request headers per the API documentation:
Authorization: Bearer <your-authentication-key>
Content-Type: application/json
  1. For sending, make the necessary POST requests.
  2. Review the API response for any errors and to ensure successful delivery.

Receiving SMS via HTTP webhook

To receive SMS messages via webhook, provide your webhook URL as described in Receive an SMS Message.

MMS via SMTP (MM4)

Configuration Details

  • SMTP Host: smtp.staging.tsgglobal.com
  • Ports: as documented on the SMTP page (2525 TCP, 2465 TLS), unless our support team gives you different values for staging
  • Authentication: AUTH LOGIN or AUTH PLAIN; username is your SMPP system ID, password is your API key
  • System ID and API key: provided by our support team.

Steps to Connect

  1. Install an SMTP client or library compatible with your system.
  2. Configure the SMTP client using the provided configuration details.
  3. Connect to the staging SMTP server.
  4. Test by sending and receiving MMS messages.
  5. Review the sample delivery reports and error messages (if any) for troubleshooting.
  6. For any additional information please refer to SMTP.

Sending MMS via HTTP API

Endpoint Information

  • Base URL: https://mms-api.staging.tsgglobal.com
  • Endpoint: see Send an MMS Message
  • Authentication key: provided by our support team.

Steps to Connect

  1. Configure the HTTP client or tool you will use for testing (e.g. Postman, curl).
  2. Set the request headers per the API documentation:
Authorization: Bearer <your-authentication-key>
Content-Type: application/json
  1. For sending, make the necessary POST requests.
  2. Review the API response for any errors and to ensure successful delivery.

Receiving MMS via HTTP webhook

To receive MMS messages via webhook, provide your webhook URL as described in Receive an MMS Message.

Troubleshooting

Below are some frequently encountered issues that may assist:

  1. Ensure you're using the correct credentials.
  2. Check your network/firewall settings to ensure communication isn't being blocked.
  3. Review error logs and messages for clues.
  4. Reach out to our support team with detailed error messages for assistance.

Conclusion

After successful testing on the staging environment, inform our support team so that they can assist you with transitioning to the production environment.