Update a phone number with messaging settings
PATCH/phone_numbers/:id/messaging
Update a phone number with messaging settings
Request
Path Parameters
Identifies the type of resource.
- application/json
Body
required
Updated messaging settings for the phone number
Unique identifier for a messaging profile.
The requested messaging product the number should be on
Responses
200: Successful response with details about a phone number including voice settings.
- application/json
- Schema
- Example (from schema)
Schema
data
object
Possible values: [messaging_phone_number, messaging_settings]
Identifies the type of the resource.
Identifies the type of resource.
+E.164 formatted phone number.
Unique identifier for a messaging profile.
ISO 8601 formatted date indicating when the resource was created.
ISO 8601 formatted date indicating when the resource was updated.
Possible values: Value must match regular expression ^[A-Z]{2}$
ISO 3166-1 alpha-2 country code.
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.
The number of messages analyzed for the health metrics.
The ratio of messages received to the number of messages sent.
The ratio of messages sucessfully delivered to the number of messages attempted.
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.
The messaging products that this number can be registered to use
The messaging traffic or use case for which the number is currently configured.
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.
Send messages to and receive messages from numbers in the same country.
Receive messages from numbers in other countries.
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.
Send messages to and receive messages from numbers in the same country.
Receive messages from numbers in other countries.
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
- Example (from schema)
Schema
Array [
]
errors
Error[]
source
object
JSON pointer (RFC6901) to the offending entity.
Indicates which query parameter caused the error.
{
"errors": [
{
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
},
"meta": {}
}
]
}