TSG Global API Documentation
  • Get Started
  • ISO/IEC/SOC Certification
  • Staging Environment Access
  • API Reference
    • Programmable SMS
      • Send an SMS Message
      • Receive an SMS Message
      • Delivery Receipts (DLRs)
      • SMPP
        • Headers
        • Errors
    • Programmable MMS
      • Send an MMS Message
      • Receive an MMS Message
      • Receive DLRs
      • SMTP
    • Phone Numbers
      • Search For New Available Numbers
      • Add Number to Cart
      • Get Reserved Numbers In Cart
      • Remove Reserved Number From Cart
      • Checkout Numbers in Cart
      • Disconnect Number
      • Get Number Information
      • Manage Number for SMS & 10DLC
        • Enable SMS/10DLC on a Number
        • Disable SMS on a Number
        • Update inbound SMS webhook/URI
      • Manage Number for MMS
        • Enable MMS on a Number
        • Disable MMS on a Number
        • Update inbound MMS webhook/URI
      • Manage Number for Voice
        • List Destination Priority
        • Add Destination Priority
        • Update Destination Priority
        • Delete Destination Priority
      • Protect your phone number
        • TextProtect Webhook
      • Toll-free phone numbers - search & ordering
    • Data Services
      • CNAM Lookup
      • Lookup SMS Carrier
    • Reports
      • CDR Records
        • Get Count of CDR Records
        • Get CDR Records
    • Compliance & Identity
      • Business Identity & 10DLC (TNID v1)
      • Toll-Free Verified Sender (Order)
      • Short Code Submission (Order)
  • GraphQL API & Authentication
Powered by GitBook
On this page
  • Overview
  • Authentication
  • Method
  • Enable SMS on a phone number.

Was this helpful?

  1. API Reference
  2. Phone Numbers
  3. Manage Number for SMS & 10DLC

Enable SMS/10DLC on a Number

Overview

This method allows you to enable SMS on (almost) any number with TSG Global.

Numbers that are searched and ordered in your cart are already SMS enabled, and you do not need to perform this function to make them SMS enabled.

Authentication

Authentication is done by passing your TSG Global API key via the Authorization header in the format "Authorization: Bearer <api_key>"

Method

Enable SMS on a phone number.

POST https://api-service.tsgglobal.world/v1/sms/enablement

Request Body

Name
Type
Description

did*

String

The DID you would like to modify"

action*

String

[add | update] (use update if you need to ammend information for already SMS-enabled number - eg. change webhook url or add campaign id)

use_case_type

String

[a2p | p2p | account_default] - p2p can be used only if you have p2p use-case approved

p2p_nnid

String

to be used with use_case_type p2p and approved nnid for p2p traffic

mms_enable

String

[true | false] - if not set, account default value will be used

mms_routing

String

http, https, mm4, mm4s url to deliver inbound mms to - if not set, account default value will be used

webhook_url

String

http or https SMS webhook url if you want inbound SMS delivered via webhook (leave blank for SMPP or account default value)

webhook_type

String

[smpp, postv1, postv2, post3jam] - leave blank for account default settings. It determines inbound message format. postv2 recommended for http(s) deliveries (if webhook url set)

x_api_key_header

String

This value will be passed as x-api-key header in the webhook http call. Can be used to secure your webhook API. (should not be provided if webhook_type is smpp)

campaign_id

String

If the number is needs to be 10DLC registered and assigned to an active campaign, the campaign id should be provided here to complete 10DLC provisioning. Note: sole proprietor campaigns only allow 1 number at a time.

skip_number_validation

String

Setting this optional prop to "true" allows you to provision number that you provided LOA for and you got confirmation from TSG team that it was accepted. Using this prop without TSG confirmation will have no effect - your request will be stale.

Success
PreviousManage Number for SMS & 10DLCNextDisable SMS on a Number

Last updated 7 months ago

Was this helpful?