Skip to main content

Update the messaging profile and/or messaging product of a phone number

PATCH 
/phone_numbers/:id/messaging

Update the messaging profile and/or messaging product of a phone number

Request ​

Path Parameters

    id stringrequired

    The phone number to update.

Body

required

The new configuration to set for this phone number.

To avoid modifying a value, either omit the field or set its value to null.

    messaging_profile_id string

    Configure the messaging profile this phone number is assigned to:

    • Omit this field or set its value to null to keep the current value.
    • Set this field to "" to unassign the number from its messaging profile
    • Set this field to a quoted UUID of a messaging profile to assign this number to that messaging profile
    messaging_product string

    Configure the messaging product for this number:

    • Omit this field or set its value to null to keep the current value.
    • Set this field to a quoted product ID to set this phone number to that product

Responses ​

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

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.

default: Unexpected error

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

  • ]

Request samples

curl -L -X PATCH 'https://api.telnyx.com/v2/phone_numbers/:id/messaging' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "messaging_profile_id": "dd50eba1-a0c0-4563-9925-b25e842a7cb6",
  "messaging_product": "P2P"
}'

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
    }
  }
}