Enable SMS 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

NameTypeDescription

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

boolean

[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)

campaign_id

String

If the number is 10dlc registered and assigned to the active campaign the campaign id should be provided here to complete 10dlc provisioning

Success

Last updated