Sign in
Phone Number Addresses

Get phone number address

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.

<Warning title="Beta">This API is in beta and may change.</Warning>

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.

get/api/fabric/phone_number_addresses/{id}

Path parameters

idstring uuid required

Universal Unique Identifier.

Unique ID of a phone number address.

Response

The request has succeeded.

idstring uuid required

Universal Unique Identifier.

type'phone' required

The object type. Always phone.

handler_type'calling' | 'messaging' required

Sets the handler to handle incoming calls or messages.

resource_idstring uuid required

Universal Unique Identifier.

namestring required

Name of the phone number address.

phone_numberstring required

The phone number in E.164 format.

phone_number_idstring uuid required

Universal Unique Identifier.

created_atstring date-time required

Date and time when the phone number address was created.

updated_atstring date-time required

Date and time when the phone number address was last updated.

Example response

{
  "type": "phone",
  "name": "main-support-number",
  "phone_number": "+13105550100",
  "created_at": "2024-05-06T12:20:00Z",
  "updated_at": "2024-05-06T12:20:00Z"
}

Changes

Changed in 4 of the 161 revisions of this API.113

Of the 161 revisions, 3 have a changelog that could not be searched.