Skip to navigation
Resource ManagementPhone Number Addresses

Get phone number address

Beta
View as MarkdownOpen in Claude

Retrieves one phone number address from your SignalWire project by ID. Use List phone number addresses to find the ID. The ID must belong to a phone number address in your project whose number you still own; an ID from another project, a different kind of resource address (for example, a SIP address), or a released number returns a 404.

Beta
This API is in beta and may change.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Calling, Fax, Messaging, or Video.

Learn more about API scopes.

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

Path parameters

idstringRequiredformat: "uuid"
Unique ID of a phone number address.

Response

The request has succeeded.
idstringformat: "uuid"
Unique identifier for the phone number address.
typeenum

The object type. Always phone.

Allowed values:
handler_typeenum

The channel this address represents: calling for inbound calls or messaging for inbound messages. A phone number has one address per channel.

Allowed values:
resource_idstring or nullformat: "uuid"

ID of the resource that handles this channel. null when no resource is assigned.

namestring
Name of the phone number address.
phone_numberstring
The phone number in E.164 format.
phone_number_idstringformat: "uuid"
ID of the phone number this address belongs to.
created_atdatetime
Date and time when the phone number address was created.
updated_atdatetime
Date and time when the phone number address was last updated.

Errors

401
Unauthorized Error
404
Not Found Error
500
Internal Server Error