Export API for Authy User Phone Numbers
As of November 2022, Twilio no longer provides support for Authy SMS/Voice-only customers. Customers who were also using Authy TOTP or Push prior to March 1, 2023 are still supported. The Authy API is now closed to new customers and will be fully deprecated in the future.
For new development, we encourage you to use the Verify v2 API.
Existing customers will not be impacted at this time until Authy API has reached End of Life. For more information about migration, see Migrating from Authy to Verify for SMS.
This API is only available for customers who intend to migrate Authy users from the Authy API to the Verify API.
By default, customers do not have access to this API endpoint. To request access, please contact support team.
Request phone number details
GET https://api.authy.com/protected/json/users/{authy_id}/phone_number
We need to pass X-Authy-API-Key header for protected endpoints.
Parameters
| Name | Type | Description |
|---|---|---|
authy_id |
Integer | Unique identifier of the user. |
Response
| Name | Type | Description |
|---|---|---|
phone_number |
String | Phone number of the user without country code. |
country_code |
String | International calling prefix. |
e164 |
String | Full phone number in E164 format. |
updated_at |
DateTime | Last update of the user in ISO-8601 format. |
Example
Listing phone number detail for user with authy_id: 1.
curl -H "X-Authy-API-Key: <api_key>" \
"https://api.authy.com/protected/json/users/1/phone_number"
Sample response
{
"phone_number": "444-555-6666",
"country_code": "1",
"e164": "+14445556666",
"updated_at": "2021-12-09T15:41:20Z"
}
Status codes
The following are the status codes supported by this API.
200: Request was successful.
400: When the request was invalid.
404: When the resource was not found.
500: Internal server error.
Common error codes
The following are the some of error codes supported by this API.
60026: User not found.
60154: Phone number export disabled.
60003: DoS protected.
Error codes
When the API returns a status other than 200, we add an error code in the message response body. For further information, please check the error codes page for a complete list of possible errors.
Supported response format
Presently we support only JSON format.
Rate limits
Below are usage limits for this API
|
Scope |
Limit |
|
|
3 per month |
|
|
1500 per minute |
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.
