Quickstart

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

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.

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

Select the Accounts tab
Click on the "Request Postpaid Account" button
Give the Account a name
Enter First Name and Last name
Enter Email Address
Enter your Company's contact Phone number
Make sure the Company name is the same as in the Tax ID records
Enter a valid Federal TaxID
Enter billing address that matches Tax ID information
Select the “I already have a Syniverse BillingID “ if you’ve already been provisioned with one
1. Enter the Billing ID
Read and Accept the Terms of Service
Click Submit. This will be in a pending state till all approvals are given.

Now you are ready to send your first SMS message.

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

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

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

Base URL: https://api.syniverse.com/scg-external-api/api/v1
A Channel ID or a Sender ID. SCG provides a Test Channel ID for your convenience. For more information on available formats for Sender IDs, check out the Sender address formats in the SMS/MMS user guide
A recipient number in E.164 format. ( If using a trial account and the recipient number is a US Mobile number, you will need to whitelist this number)
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

Sample Curl Request using a Channel ID

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

Sample Curl Request using a Sender ID format

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

Sample Curl Request using a Sender address format

Please note that to use a Sender address, you must already have created a Sender ID.

curl -X POST -H "Authorization: Bearer [Access Token]" -H "Content-Type: application/json" -d '{"from":address:18325551515","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 = https://api.syniverse.com/scg-external-api/api/v1/messaging/message_requests
payload = "{\"from\":\"channel:1KJPMkuHQkair_o15etpmg\",\"to\":[\"+14082225555\"],\"body\":\"Hello this is my first message\"}"
headers = {
    'authorization': "Bearer TOKEN",
    'content-type': "application/json",
       }
response = requests.request("POST", url, json=payload, headers=headers)
print(response.status_code)
print(response.text)

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

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

The SCG UI dashboard includes the following Menu structure:

Sending Messages via UI

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

View Status of Sent Message in UI

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

View Received Messages

Select “INBOX” under the message tab
View messages in your inbox….latest messages is usually on top
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:

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.
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