post

/anonymous/session/sms

The Anonymous SMS API allows you to have two end users engage in SMS communication with one another without either party disclosing their phone numbers. You and TeleSign will know their numbers and track their interactions so you can be sure they are not violating your terms of use.

All requests submitted for the Anonymous SMS API:

  • Can be authenticated with Basic (easiest to implement) and Digest authentication
  • Use https://rest-ww.telesign.com/v1/anonymous/session/sms as the base endpoint
  • Accept only UTF-8 encoded unicode characters as inputs
  • Use Content-Type - application/json in request headers

Request Body

Schema
object
phone_number_1
string

The phone number for one of the end users that will engage in the anonymous exchange.

phone_number_2
string

The phone number for the other end user that will engage in the anonymous exchange. Must be different from phone_number_1.

validity_period
integer

An integer representing the amount of time you want the two end users to be able to communicate for. The unit this number represents can be seconds, minutes, hours, or days. The unit used is configured by TeleSign; ask our Customer Support Team if you need it changed. The maximum value depends on the units configured for your account, but will always be equivalent to 720 hours.

2 validations

Responses

Your request was fulfilled and resulted in a new resource being created. If you want to code against a response, you should retrieve the status or error code and use that rather than the HTTP status response.

Status Code Description
2700 Session successfully created
Schema
object
data
object

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
1 variable not set
host