Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Deactivations Resource


This resource retrieves a list of United States phone numbers that have been deactivated by mobile carriers. These phone numbers are no longer in service for the subscriber who used to own that number. Twilio updates the set of available reports daily.

These reports should be used periodically to remove deactivated phone numbers from your opted-in subscriber list. For more information how to use these reports, see the "Handling Deactivated Phone Numbers" Help Center article(link takes you to an external page).

API requests to the Deactivations Resource are free of charge.


Deactivation Properties

deactivation-properties page anchor
redirect_tostring<uri>
Not PII

Returns an authenticated url that redirects to a file containing the deactivated numbers for the requested day. This url is valid for up to two minutes.


Fetch a Deactivation resource

fetch-a-deactivation-resource page anchor
GET https://messaging.twilio.com/v1/Deactivations

Send a GET request to the Deactivations list resource to retrieve a list of deactivated numbers for a specific date.

You must include the Date parameter with a date value in YYYY-MM-DD format.

Twilio's response contains a redirect_to property with a signed URL for the requested date's deactivations list in .txt format.

Query parameters

query-parameters page anchor
Datestring<date>

The request will return a list of all United States Phone Numbers that were deactivated on the day specified by this parameter. This date should be specified in YYYY-MM-DD format.

Fetch deactivations for August 13, 2023

fetch-deactivations-for-august-13-2023 page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.messaging.v1.deactivations()
_10
.fetch({date: new Date(Date.UTC(2023, 7, 13))})
_10
.then(deactivations => console.log(deactivations.redirectTo));

Output

_10
{
_10
"redirect_to": "https://com-twilio-dev-messaging-deactivations.s3.amazonaws.com"
_10
}


Rate this page: