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:
- Completed Sender ID import template. (CSV.format)
- 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 -L -X POST 'https://api.syniverse.com/scg-external-api/api/v1/messaging/attachments' -H 'Authorization: Bearer {TOKEN}' -H 'Content-Type: application/json;charset=UTF-8' --data-raw '{"designation":"SENDERIDS_IMPORT", "name":"Longcode Import","type":"application/vnd.ms-excel","filename":"KolaTESTTFN.csv"}'
Response will return the attachmentId - { F7lytrfMzpzJa3wEc41Wu6}
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 -L -X POST 'https://api.syniverse.com/scg-external-api/api/v1/access_tokens' -H 'Authorization: Bearer TOKEN' -H 'Content-Type: application/json;charset=UTF-8' --data-binary
'{"resource":"ATTACHMENT","resource_id":"F7lytrfMzpzJa3wEc41Wu6"}'
Response: {PfytmJmH56J5hz3J6J1hU}
3) Upload Attachment Data (using the access token)
curl -L -X POST 'https://api.syniverse.com/scg-attachment/api/v1/messaging/attachments/PfytmJmH56J5hz3J6J1hU/content' -H 'Authorization: Bearer{TOKEN} -H 'Content-Type: application/octet-stream' --data-binary '@/C:/Users/Downloads/KolaTESTTFN.csv'
Submit your receipt/LOA
4) Create Receipt/LOA Attachment
curl -L -X POST 'https://api.syniverse.com/scg-external-api/api/v1/messaging/attachments' -H 'Content-Type: application/json' -H 'Authorization: Bearer {TOKEN}' --data-raw
'{
"name": "MyTFN Receipt",
"type": "text/pdf",
"filename": "KolanatorLOA.pdf"
}'
Response: { Tko6LS4BTUCiAUOpl6nW52}
5) Create an Access Token for Uploading the Receipt (Returns Access Token)
curl -L -X POST 'https://api.syniverse.com/scg-external-api/api/v1/access_tokens' -H 'Authorization: Bearer {TOKEN}' -H 'Content-Type: application/json' --data-raw
'{
"resource": "ATTACHMENT",
"resource_id": "Tko6LS4BTUCiAUOpl6nW52"
}'
Response: { EXbePdKHCB6HBuyj6e5NU7}
6) Upload the Receipt/LOA data
Using the access token, call the API to upload your LOA/Receipt
curl -L -X POST 'https://api-int.syniverse.com/scg-attachment/api/v1/messaging/attachments/EXbePdKHCB6HBuyj6e5NU7/content' -H 'Content-Type: application/octet-stream' -H 'Authorization: Bearer {Token}'
--data-binary '@/C:/Users/OneDrive - Syniverse/Documents/KolanatorLOA.pdf'
7) Create Toll-free Sender IDs with Attachment ID and Receipt ID
curl -L -X POST 'https://api.syniverse.com/scg-external-api/api/v1/sender_ids_import' -H 'Authorization: Bearer {Token}' -H 'Content-Type: application/json' --data-raw
'{
"import_attachment_id": "F7lytrfMzpzJa3wEc41Wu7",
"receipts_attachment_id": "Tko6LS4BTUCiAUOpl6nW52",
"register_number": false,
"tollfree_billing": {
"receipt": "Kolanator_receipt",
"expiration_date": "",
"company_name": "James_Company",
"company_id": "1512",
"authorized_user":"Kola",
"phone": "+14085551212",
"email": "kola-email@syniverse.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"
}
}'
0 Comments