Customers that already have their own Toll-free numbers can migrate them to the Syniverse CPaaS platform to be Text-enabled for sending SMS messages. Customers must ensure that they can prove ownership of these numbers by submitting a completed LOA (Letter of Authorization) see attached. Customer must indicate if they are migrating from another Service provider in the completed LOA

Text-enabled Toll-free numbers can be used to send A2P SMS messages only. Customer must ensure they have completed a Service agreement with Syniverse for Toll-free messaging and have accepted all necessary terms of service required to use this service.

Getting Started

Submit your list of Toll-free numbers that you want to migrate along with a completed LOA to your assigned Implementation Manager or Account Manager. In this initial step, text-enablement and registration would be performed by your Implementation manager. Once completed, they will inform you on the next step.

Submit a TFN Sender ID batch import via API

This API resource allows you to import your already registered/text-enabled Toll-free numbers to create Sender IDs. Prior to invoking this API resource, make sure you have completed the following:

1. Completed Sender ID import template. (CSV.format)

2. Copy of your LOA/receipt in pdf format.

With both information complete the following Steps to Upload your TFN and Create their Sender IDs

1) Create a Sender ID import attachment

When using this API resource, make sure the value of the "filename" attribute matches the name of the file you are creating an attachment for

curl --location 'https://api.syniverse.com/scg-external-api/api/v1/messaging/attachments' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {TOKEN}' \
--data '{
"designation":"SENDERIDS_IMPORT",
"name":"Toll-free Import", 
"type":"application/vnd.ms-excel", 
"filename":"senderAddressImportTemplate.csv"
}'

Response will return the attachmentId also known as Resource ID
{
"id": "{ResourceID}"
}

2) Create an Access Token for Uploading the Sender ID Attachment Data (Returns Access Token)

Using the attachment ID received from Step 1, submit a request for the access token using the value of the attachment ID in the resource_id attribute in the JSON payload

curl --location 'https://api.syniverse.com/scg-external-api/api/v1/access_tokens' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {TOKEN}' \
--data '{
"resource": "ATTACHMENT",
"resource_id": "{ResourceID}"
}'

API Response return Access Token (to be used for uploading the file):
{
"id": "{Access Token}"
}

3) Upload Attachment Data (using the access token)

curl --location 'https://api.syniverse.com/scg-attachment/api/v1/messaging/attachments/{AccessToken}/content' \
--header 'Content-Type: */*' \
--header 'Authorization: Bearer {TOKEN}' \
--data '@/C:/Users/senderAddressImportTemplate.csv'

 

Submit your receipt/LOA

4) Create Receipt/LOA Attachment

curl --location 'https://api.syniverse.com/scg-external-api/api/v1/messaging/attachments' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {TOKEN}' \
--data '{
"name":"MyTFN Receipt", 
"type":"text/pdf", 
"filename":"Syniverse Letter of Authorization - TFN.pdf"
}'

Response will return the attachmentId also known as Resource ID
{
"id": "{ResourceID}"
}

 

5) Create an Access Token for Uploading the Receipt (Returns Access Token)

curl --location 'https://api.syniverse.com/scg-external-api/api/v1/access_tokens' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {TOKEN}' \
--data '{
"resource": "ATTACHMENT",
"resource_id": "{ResourceID}"
}'

API Response return Access Token (to be used for uploading the file)
{
"id": "{Access Token}"
}

 

6) Upload the Receipt/LOA data

Using the access token, call the API to upload your LOA/Receipt

curl --location 'https://api.syniverse.com/scg-attachment/api/v1/messaging/attachments/{AccessToken}/content' \
--header 'Content-Type: */*' \
--header 'Authorization: Bearer {TOKEN}' \
--data '@/C:/Users/SyniverseLetterofAuthorization-TFN.pdf'

 

7) Create Toll-free Sender IDs with Attachment ID and Receipt ID

curl --location 'https://api.syniverse.com/scg-external-api/api/v1/sender_ids_import' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {TOKEN}' \
--data-raw '{
    "import_attachment_id":"{ResourceID}",
    "receipts_attachment_id":"{ResourceID}",
    "register_number":false,
    "tollfree_billing": {
        "receipt": "TollFreeReceipt",
        "expiration_date": "",
        "company_name": "{CustomerName}",
        "company_id": "{CompanyID}",
        "authorized_user":"{NAME}",
        "phone": "+{Phone}",
        "email": "user@email.com",
        "message_type": "SMS",
        "description": "description",
        "campaign_type": "campaign_type",
        "country": "USA",
        "expected_date_of_service": "2021-01-01",
        "use_case": "test-usecase",
        "estimated_volume": "10000",
        "campaign_website": "https://www.syniverse.com",
        "campaign_discovery": "Web"
    }
}'