Skip to main content

Update a phone number with messaging settings

PATCH 

/phone_numbers/:id/messaging

Update a phone number with messaging settings

Request

Path Parameters

    id stringrequired

    Identifies the type of resource.

Body

required

Updated messaging settings for the phone number

    messaging_profile_id string

    Unique identifier for a messaging profile.

    messaging_product string

    The requested messaging product the number should be on

Responses

200: Successful response with details about a phone number including voice 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.

    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.

    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.

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
  • ]

Loading...