Retrieve a 'TN'

GET /messaging/numbers/:tn

Retrieves the specified phone number's existing messaging settings.

Request

Path Parameters

tn stringrequired

E.164 formatted phone number (without the plus sign)

Responses

200: Requested 'TN'

application/json

Schema

num stringrequired

+E.164 formatted phone number

user_id uuidrequired

ID of user who owns the phone number

profile_id uuid

ID of messaging profile, or '' if unassigned

last_updated integer

Possible values: Value must match regular expression ^(([0-9]{16})|0)$

Default value: 0

Updated at time (Unix time in microseconds), or '0' if unknown

country_code string

Number's Country Code

campaign_id string

The messaging campaign ID associated with the short-code

num_country string

Possible values: Value must match regular expression ^(([A-Z]{3}))$

The ISO 3166-1 alpha-3 country code of the country of origin for the number

traffic_type string

The messaging product the number is registered with

num_type string

The type of the phone number

sms

object

The SMS features associated with the phone number

enabled booleanrequired

False if the features are not currently enabled, true if the features are currently enabled.

domestic_two_way booleanrequired

Domestic two way messaging feature

international_inbound booleanrequired

International inbound messaging feature

international_outbound booleanrequired

International outbound messaging feature