SCG Quick Start guide

Quick Start guide to using the SCG Voice & Messaging Service.

To get started, please read and familiarize yourself with the Voice and Messaging Service offering user guide and API resource documents. Both documents are available and can be accessed under the documents menu.

Once registration is completed through the SDC (Syniverse Developer Community) portal and you are automatically subscribed to the Voice and Messaging service offering. Next step is to configure your application and payment account.

 

Now you are ready to send your first SMS message.

Syniverse Communication Gateway offers APIs for sending and receiving messages over SMS, MMS, Social Messaging services (Facebook Messenger & WeChat) , RCS and Push Notification services.

Sending a SMS or MMS MT (Mobile Termination) Message via API or UI

 

Sending a SMS MT (Mobile Termination) Message

To send a SMS message to a recipient via the SMS API , you will need the following:

  1. Base URL: https://api.syniverse.com/scg-external-api/api/v1
  2. A Channel ID or a Sender ID. SCG provides a Test Channel ID for your convenience.
  3. A recipient number in E164 format. ( If using a trial account and the recipient number is a US Mobile number, you will need to whitelist this number)
  4. Bearer Token: This is your Access token that is generated with your registered application.

Using your application, POST a message request to the provided base URL using the sample CURL below:

Syniverse has provided you with a Public US Test Channel, Channel ID = 1KJPMkuHQkair_o15etpmg

Request:

curl -X POST -H "Authorization: Bearer [Access Token]" -H "Content-Type: application/json" -d '{"from":"channel: 1KJPMkuHQkair_o15etpmg ","to":["+14082225555"],"body":"Hello from SCG message"}' https://api.syniverse.com/scg-external-api/api/v1/messaging/message_requests

Response:

"id": "SJciWWUnfw369P9KyTnkJ2"

 

Python Sample Code snippet to send a SMS

import requests
url = "<a rel="nofollow" target="_blank" href="https://api.syniverse.com/scg-external-api/api/v1/messaging/message_requests">https://api.syniverse.com/scg-external-api/api/v1/messaging/message_requests</a>"
payload = "{\"from\":\"channel:1KJPMkuHQkair_o15etpmg\",\"to\":[\"+14082225555\"],\"body\":\"Hello this is my first message\"}"
headers = {
    'authorization': "Bearer 3c5a336df4d9d3f3e4d129a755b0f377",
    'content-type': "application/json",
       }
response = requests.request("POST", url, json=payload, headers=headers)
print(response.status_code)
print(response.text)

For sample libraries and cURLs to get you started, visit our repositories here

Optionally, you can also access the Voice & Messaging Offering GUI application for a visual function of the APIs

The SCG UI dashboard includes the following Menu structure:

Sending Messages via UI

  1. Select Messaging and click on “ Send Message”
  2. If you are sending a SMS, make sure the SMS tab is selected and input your parameters.
  3. Select a Sender ID or Channel you wish to Send from
  4. Input a mobile number ( International format) or select from a contact list or Contact group
  5. Select the appropriate template if sending from Syniverse public channel or Sender ID otherwise input you message in the Message box
  6. Click Send or Cancel.

View Status of Sent Message in UI

  1. Select “Outbox” under the Message tab
  2. View your message details in the window. Double-Click Message to get more details

View Received Messages

  1. Select “INBOX” under the message tab
  2. View messages in your inbox….latest messages is usually on top
  3. Click message for more details.

Receiving a SMS MO (Mobile Originated) message in your Application

To receive SMS messages sent to your application from a mobile phone number, you will need the following:

  1. Purchase a Dedicated Sender Address: This is a unique identifier to which a user can sender you a message. For more info on Sender Address, please check out the SCG user guide. To Purchase a Dedicated Sender Address to use for your application, please refer to the "How to Purchase a Sender ID on SCG " article. Please note that a payment account is required to purchase a dedicated Sender address. Your Trial account cannot be used to purchase a Sender Address.
  2. A subscription to Events Manager: This is a Callback service where all the events including MO messages destined for your application is POST to your application. For more info on how to subscribe and setup your application to receive status events, please visit the SMS/MMS user guide here

Setting up a Payment Account

Postpaid Account

NOTE: It is recommended you work directly with a Syniverse representative when setting up a postpaid account.

While logged in, navigate to the Company menu by clicking on account name on the far right corner of the portal

  1. Select the Accounts tab
  2. Click on the "Request Postpaid Account" button
  3. Give the Account a name
  4. Select if you want to have a Restricted account (only users with specific entitlements can access this account)
  5. Enter First Name and Last name
  6. Enter Email Address
  7. Enter your Company's contact Phone number
  8. Make sure the Company name is the same as in the Tax ID records
  9. Enter a valid Federal TaxID
  10. Enter billing address that matches Tax ID information
  11. Select the “I already have a Syniverse BillingID “ if you’ve already been provisioned for one
    1. Enter the Billing ID
  12. Read and Accept the Terms of Service
  13. Click Submit. This will be in a pending state till all approvals are given.
Was this article helpful?
0 out of 0 found this helpful

0 Comments

Article is closed for comments.