Retrieve a phone number with messaging settings

GET /phone_numbers/:id/messaging

Request

Path Parameters

id stringrequired

Identifies the type of resource.

Responses

200: Successful response with details about a phone number including messaging settings.

application/json

Schema

data

object

record_type string

Possible values: [messaging_phone_number, messaging_settings]

Identifies the type of the resource.

id string

Identifies the type of resource.

phone_number e164

+E.164 formatted phone number.

messaging_profile_id stringnullable

Unique identifier for a messaging profile.

created_at date-time

ISO 8601 formatted date indicating when the resource was created.

updated_at date-time

ISO 8601 formatted date indicating when the resource was updated.

country_code string

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

ISO 3166-1 alpha-2 country code.

type string

Possible values: [long-code, toll-free, short-code, longcode, tollfree, shortcode]

The type of the phone number

health

object

High level health metrics about the number and it's messaging sending patterns.

message_count integerrequired

The number of messages analyzed for the health metrics.

inbound_outbound_ratio floatrequired

The ratio of messages received to the number of messages sent.

success_ratio floatrequired

The ratio of messages sucessfully delivered to the number of messages attempted.

spam_ratio floatrequired

The ratio of messages blocked for spam to the number of messages attempted.

High level health metrics about the number and it's messaging sending patterns.

eligible_messaging_products string[]

The messaging products that this number can be registered to use

traffic_type string

The messaging traffic or use case for which the number is currently configured.

messaging_product string

The messaging product that the number is registered to use

features

object

sms

object

nullable

The set of features available for a specific messaging use case (SMS or MMS). Features can vary depending on the characteristics the phone number, as well as its current product configuration.

domestic_two_way booleanrequired

Send messages to and receive messages from numbers in the same country.

international_inbound booleanrequired

Receive messages from numbers in other countries.

international_outbound booleanrequired

Send messages to numbers in other countries.

The set of features available for a specific messaging use case (SMS or MMS). Features can vary depending on the characteristics the phone number, as well as its current product configuration.

mms

object

nullable

The set of features available for a specific messaging use case (SMS or MMS). Features can vary depending on the characteristics the phone number, as well as its current product configuration.

domestic_two_way booleanrequired

Send messages to and receive messages from numbers in the same country.

international_inbound booleanrequired

Receive messages from numbers in other countries.

international_outbound booleanrequired

Send messages to numbers in other countries.

The set of features available for a specific messaging use case (SMS or MMS). Features can vary depending on the characteristics the phone number, as well as its current product configuration.

{
  "data": {
    "record_type": "messaging_settings",
    "id": "1293384261075731499",
    "phone_number": "+18005550001",
    "messaging_profile_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "created_at": "2019-01-23T18:10:02.574Z",
    "updated_at": "2019-01-23T18:10:02.574Z",
    "country_code": "US",
    "type": "toll-free",
    "health": {
      "message_count": 122,
      "inbound_outbound_ratio": 0.43,
      "success_ratio": 0.94,
      "spam_ratio": 0.06
    },
    "eligible_messaging_products": [
      "A2P"
    ],
    "traffic_type": "A2P",
    "messaging_product": "A2P",
    "features": {
      "sms": {
        "domestic_two_way": true,
        "international_inbound": true,
        "international_outbound": true
      },
      "mms": null
    }
  }
}

default: Unexpected error

application/json

Schema

errors

Error[]

Array [

code integerrequired

title stringrequired

detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta object

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}

Request samples

curl -L 'https://api.telnyx.com/v2/phone_numbers/:id/messaging' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

{
  "data": {
    "record_type": "messaging_settings",
    "id": "1293384261075731499",
    "phone_number": "+18005550001",
    "messaging_profile_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "created_at": "2019-01-23T18:10:02.574Z",
    "updated_at": "2019-01-23T18:10:02.574Z",
    "country_code": "US",
    "type": "toll-free",
    "health": {
      "message_count": 122,
      "inbound_outbound_ratio": 0.43,
      "success_ratio": 0.94,
      "spam_ratio": 0.06
    },
    "eligible_messaging_products": [
      "A2P"
    ],
    "traffic_type": "A2P",
    "messaging_product": "A2P",
    "features": {
      "sms": {
        "domestic_two_way": true,
        "international_inbound": true,
        "international_outbound": true
      },
      "mms": null
    }
  }
}

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}

Retrieve a phone number with messaging settings

Request​

Path Parameters

Responses​

Request

Responses