User Guide for Syniverse Developer Community

---

The Syniverse Developer Community is your gateway to Syniverse solutions. The Quick Start step by step process below helps you:

• SignUp
• Setup required services
• Create an Application
• Send a Message
• Complete the Company environment setup

Prerequisites

Syniverse Developer Community does not have any requirements from other Syniverse Services. This user guide creates a completely new Company entity into the Syniverse Developer Community. If you already have a Company in the platform then please login into that Company and start from Section "Ready to Start?"

Related Services

Syniverse Developer Community is the core of all services in the platform. This user guide focuses on getting started with APIs related to the Voice & Messaging Offering family and specifically with SMS API. To get started with other Services please go to the following User Guides:

• Phone Number Verification User Guide
• Event Manager User Guide
• Chat API User Guide
• SMS API User Guide
• Voice API User Guide
• Over the Top Messaging User Guide
• Push API User Guide
• Reporting User Guide
• Media Storage User Guide
• Batch Automation User Guide
• Multi-Factor Authentication User Guide
• Consent Management User Guide

Quick Start Guide

Here we will describe the key elements in the Syniverse Developer Community Service so that you have an environment in the platform, which is ready to be used with multiple services

SignUp

1. Click on top right navigation of the site
   1. Enter requested information
   2. If you already have an invitation code from a Company in the Syniverse Developer Community enter that into "Company invite code" field, This field can be empty
   3. Read and Accept Terms of Service
   4. Check the reCaptcha box (the service might ask you for additional verifications)
   5. Click "Create profile"
2. Check your email for confirmation link
   1. Click link in email
   2. Verify your user credentials
3. Login with the credentials you created in step 1

Ready to start?

After login you see the dashboard. Dashboard contains key information about your environment with statistics about usage and notifications that require action or review in Syniverse Developer Community.

Ready to send your first test message? Follow these guidelines:

1. Click for Subscription to a Service Offering
   1. Click Voice & Messaging Offering
   2. Expand "Subscriptions" menu
   3. Click "Subscribe..." and select "Initial account for [Your username]"
   4. Accept Terms of Service
   5. Click
   6. Verify that your "Initial account for [Your username]" is listed in Subscriptions
2. Click for Application Creation and Setup
   1. Click
   2. Give your Application a name and description, Click Save
   3. Click icon next to your app name and select "Edit"
   4. Expand "Account & APIs" menu
   5. Select the "Initial account for [Your username]" from drop down menu
   6. Turn "Voice & Messaging" and "Whitelisting Services" On
   7. Expand "Auth Keys"
   8. You can Re-Generate the Access token (optional)
   9. Copy and store keys in a safe place
   10. Click "Save"
3. Hover over "Your Name" on top right corner. to Whitelist a Phone Number so test messages can be sent
   1. Click "Company"
   2. You can give your Company a name (Optional)
   3. Scroll down and Click tab
   4. Click "Add phone number"
   5. Enter your mobile number and click "Send confirmation code"
   6. Enter the code you received as an SMS
   7. Click "Add"

As a last step you would need to go to the Voice & Messaging Offering UIand get channel ID for the public channel:

4. Click
   1. Click the link icon next to "Voice and Messaging"
   2. If asked to login, please provide your credentials
   3. In Voice & Messaging Offering UI Click "Messaging Accounts"
   4. Click "Public Channels"
   5. Copy the ChannelID for US MT Test Channel or Public US Test Channel

You are now ready to send a message.

You now have two options to send a message:

Option 1: Sending a message from the Voice & Messaging UI
- Go to the Voice & Messaging UI
- Click the "Messaging"
- Click "Send Message"
- In the "From" field, Click "Use Channel"
- Select the "Public US Test Channel"
- In the "To" field, Enter whitelisted phone number
- In the "Message" field, Enter the message you want to send
- Click "Send"

Option 2: Sending a message through an API
To make an API call you need to use the access token and the ChannelID recorded in previous steps, to send a message to the number whitelisted earlier
POST: https://api.syniverse.com/scg-external-api/api/v1/messaging/message_requests
{ "from":"channel:[channelID]", "to":"[+1Your mobile number]", "body":"Testing SMS message sending through API!" }
Response: HTTP/1.1 200 OK { "id":"[Unique identifier]" }
curl -X POST -H "Authorization: Bearer [Access Token]" -H "Content-Type: application/json" -d '
{
"from":"channel:[channelID]",
"to":["+1Your mobile number"],
"body":"Testing SMS message sending through API!"
}' 'https://api.syniverse.com/scg-external-api/api/v1/messaging/message_requests'

When sending messages please make sure the phone number is in the ITU-T E.164 format.

Completion of the Company Environment

In this step we will complete your Company environment so that your environment is ready for full production deployment.

1. Add a Payment method. This is setting up a prepayment environment with a Credit Card
1. Hover over [Your name]
2. Click "Company"
3. Select tab
4. Click "Add payment method"
5. Enter a name to your payment method, so that you can identify it later
6. Select the Billing address associated with this payment method (or enter a new one)
7. Enter your Credit card details
8. Click "Add"
2. Add an Account Account connects your Application to Services and APIs, while managing the funds
1. Hover over "Your name"
2. Click "Company"
3. Selecttab
4. Click "Add Account" (This creates a prepay account)
5. Click checkbox if you want to create a Restricted Account
6. Give your account a name
7. Click "Add"
8. Click the account you just created
9. Verify that an address is attached to your account, if not attach an address to the Account
10. Click the "+" sign next to Available Funds
11. Enter the amount you want to put into your account (minimum amount is $20)
12. Select the payment method you want to use
13. Click "Confirm"
3. Click
   1. Click "Voice & Messaging Offering"
   2. Expand "Subscriptions"
   3. Click "Subscribe..."
   4. Select your newly created account
   5. Read and Click the checkbox to Accept the Terms of Service
   6. Click "Confirm"
   7. Repeat steps a through e but for "SDC Self Service"
4. Create new Application or use the previously created Application

EDITING an existing Application

1. Click
2. Click the icon and select edit next to the Application you already have in place
3. Go to Accounts and APIs
4. Select the new Account created previously
5. Turn on the Voice & Messaging and any additional resources you want your application to have access
6. Verify that application has all the permissions from "Application Permissions" menu
7. Copy the Auth Keys in case you have not already stored them
8. Click "Save"

CREATING a new Application

1. Click
2. Click "New application"
3. Give your Application a name and description, Click "Save"
4. Click icon next to your app name and select "Edit"
5. Click "Account & APIs"
6. Select the Account you have created
7. Turn on the Voice & Messaging and any additional resources you want your application to have access
8. Verify that your Application has all the correct permissions
9. Copy authentication keys
10. Click "Save"