E911 Addresses

Create E911 address

Changed on

Creates a physical E911 service address that can be assigned to an owned phone number for emergency calling. Use it before Assign an E911 address to a phone number when emergency services need the caller's registered street location. Do not use this endpoint for a resource address or SIP URI.

When emergency_enabled=true and the address is in the US (country = US), the address is validated against the carrier. A valid or auto-corrected address is stored (validated: true). An address the carrier cannot validate — or a correctable address when auto_correct_address=false — is rejected with a 422 whose body includes an errors array and a candidates array of suggested addresses (each with street_number, street_name, city, state, postal_code). Carrier validation applies to US addresses only: a non-US address is stored normally, with emergency_enabled returned as false. Requests without emergency_enabled are stored without carrier validation.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Numbers.

Learn more about API scopes.

post/api/relay/rest/addresses

Request

  • Base URL
    https://{Your_Space_Name}.signalwire.com
  • URL
    https://{Your_Space_Name}.signalwire.com/api/relay/rest/addresses
  • Auth
    HTTP basic

Request body

labelstring required

A friendly name given to the address to help distinguish and search for different addresses within your project. When the address is assigned to a phone number for E911, this label is also sent to the carrier as the caller name. The emergency network limits that field to 32 characters, so longer labels are truncated to the first 32 characters before being sent. Truncation affects only the name shown to the dispatcher, never the address used to route the call.

countrystring required

The ISO 3166 Alpha 2 country code.

first_namestring required

First name of the occupant associated with this address.

last_namestring required

Last name of the occupant associated with this address.

street_numberstring required

The number portion of the street address.

street_namestring required

The name portion of the street address.

address_type'Apartment' | 'Basement' | 'Building' | 'Department' | 'Floor' | 'Office' | 'Penthouse' | 'Suite' | 'Trailer' | 'Unit'

Address type for sub-addresses.

address_numberstring

If the address is divided into multiple sub-addresses, this identifies the particular sub-address.

citystring required

The city portion of the street address.

statestring required

The state/province/region of the street address. In the USA and Canada, use the two-letter abbreviated form.

postal_codestring required

The postal code of the street address.

emergency_enabledboolean

Applies to US addresses only. When true and country is US, the address is validated against the carrier before it is stored. For any other country the flag is ignored and the response returns emergency_enabled: false. Defaults to false, which stores the address without carrier validation.

auto_correct_addressboolean

When the carrier suggests a corrected version of the address, true (the default) stores the corrected address; false rejects the request with the suggestion returned as candidates.

Example request

{
  "label": "My Address",
  "country": "US",
  "first_name": "Emmett",
  "last_name": "Brown",
  "street_number": "1640",
  "street_name": "Riverside Drive",
  "address_number": "42",
  "city": "Alexandria",
  "state": "CA",
  "postal_code": "91905",
  "emergency_enabled": true,
  "auto_correct_address": true
}

Response

The request has succeeded.

idstring uuid required

Universal Unique Identifier.

labelstring required

A friendly name given to the address to help distinguish and search for different addresses within your project.

countrystring required

The ISO 3166 Alpha 2 country code.

first_namestring required

First name of the occupant associated with this address.

last_namestring required

Last name of the occupant associated with this address.

street_numberstring required

The number portion of the street address.

street_namestring required

The name portion of the street address.

address_type'Apartment' | 'Basement' | 'Building' | 'Department' | 'Floor' | 'Office' | 'Penthouse' | 'Suite' | 'Trailer' | 'Unit' required

Address type for sub-addresses.

address_numberstring nullable required

If the address is divided into multiple sub-addresses, this identifies the particular sub-address.

citystring required

The city portion of the street address.

statestring required

The state/province/region of the street address. In the USA and Canada, use the two-letter abbreviated form.

postal_codestring required

The postal code of the street address.

zip_codestring required

The postal code of the street address. Alias for postal_code for backwards compatibility.

emergency_enabledboolean required

Whether E911 emergency calling is enabled for this address (carrier-validated when created/updated with emergency_enabled=true for a US address).

validatedboolean required

Whether the address was validated by the carrier (true when the carrier returned a valid or auto-corrected match).

validated_atstring nullable required

The RFC 3339 / ISO 8601 timestamp of the last successful carrier validation, or null if never validated.

Example response

{
  "label": "My Address",
  "country": "US",
  "first_name": "Emmett",
  "last_name": "Brown",
  "street_number": "1640",
  "street_name": "Riverside Drive",
  "address_number": "42",
  "city": "Alexandria",
  "state": "CA",
  "postal_code": "91905",
  "zip_code": "91905"
}

Changes

  • dd526f1cd683Revision changes
    • breaking

      removed the success response with the status

    • info

      the request property default value true was added

    • info

      the request property default value false was added

    • info

      added the optional property to the response with the status

    • info

      added the success response with the status

  • e9f0b2ed4396Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

Some revisions have not been checked yet.