# Import a Phone Number

POST https://YOUR_SPACE.signalwire.com/api/relay/rest/imported_phone_numbers
Content-Type: application/json

Import a phone number hosted elsewhere into your SignalWire Space.

**Note:** This is a **Partner API**. To enable it on your SignalWire Space, contact [Sales](https://signalwire.com/company/contact?utm_campaign=devex_sent_em).

#### 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](/docs/platform/your-signalwire-api-space).

Reference: https://signalwire.com/docs/apis/relay-rest/imported-phone-numbers/create-imported-phone-number

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: relay-rest
  version: 1.0.0
paths:
  /imported_phone_numbers:
    post:
      operationId: create-imported-phone-number
      summary: Import a Phone Number
      description: >-
        Import a phone number hosted elsewhere into your SignalWire Space.


        **Note:** This is a **Partner API**. To enable it on your SignalWire
        Space, contact
        [Sales](https://signalwire.com/company/contact?utm_campaign=devex_sent_em).


        #### 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](/docs/platform/your-signalwire-api-space).
      tags:
        - subpackage_importedPhoneNumbers
      parameters:
        - name: Authorization
          in: header
          description: >-
            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)

            ```
          required: true
          schema:
            type: string
      responses:
        '201':
          description: >-
            The request has succeeded and a new resource has been created as a
            result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneNumberResponse'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode401'
        '422':
          description: The request failed validation. See errors for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.ValidationError'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImportPhoneNumberRequest'
servers:
  - url: https://YOUR_SPACE.signalwire.com/api/relay/rest
components:
  schemas:
    ImportPhoneNumberRequestNumberType:
      type: string
      enum:
        - longcode
        - tollfree
      description: The type of phone number being imported.
      title: ImportPhoneNumberRequestNumberType
    ImportPhoneNumberRequestCapabilitiesItems:
      type: string
      enum:
        - sms
        - voice
        - fax
        - mms
      title: ImportPhoneNumberRequestCapabilitiesItems
    ImportPhoneNumberRequest:
      type: object
      properties:
        number:
          type: string
          description: >-
            The phone number to import in E.164 format. Number must be between 5
            and 30 characters with no special characters besides a leading +.
        number_type:
          $ref: '#/components/schemas/ImportPhoneNumberRequestNumberType'
          description: The type of phone number being imported.
        capabilities:
          type: array
          items:
            $ref: '#/components/schemas/ImportPhoneNumberRequestCapabilitiesItems'
          description: >-
            The capabilities to enable for this phone number. Can include any
            combination of SMS, Voice, Fax, and MMS. If not provided, defaults
            to all capabilities.
      required:
        - number
        - number_type
      description: Request body for importing a phone number.
      title: ImportPhoneNumberRequest
    uuid:
      type: string
      format: uuid
      description: Universal Unique Identifier.
      title: uuid
    PhoneNumberCapability:
      type: string
      enum:
        - voice
        - sms
        - mms
        - fax
      description: Phone number capability.
      title: PhoneNumberCapability
    PhoneNumberType:
      type: string
      enum:
        - toll-free
        - longcode
      description: Phone number type.
      title: PhoneNumberType
    PhoneNumberCallHandler:
      type: string
      enum:
        - relay_context
        - relay_topic
        - relay_script
        - relay_application
        - relay_connector
        - relay_sip_endpoint
        - relay_verto_endpoint
        - laml_webhooks
        - laml_application
        - dialogflow
        - video_room
        - call_flow
        - ai_agent
        - fabric_subscriber
        - sip_gateway
        - call_queue
      description: Call handler type for phone numbers.
      title: PhoneNumberCallHandler
    CallReceiveMode:
      type: string
      enum:
        - voice
        - fax
      description: Call receive mode.
      title: CallReceiveMode
    HttpMethod:
      type: string
      enum:
        - GET
        - POST
      description: HTTP method type.
      title: HttpMethod
    PhoneNumberMessageHandler:
      type: string
      enum:
        - relay_context
        - relay_topic
        - relay_application
        - laml_webhooks
        - laml_application
      description: Message handler type for phone numbers.
      title: PhoneNumberMessageHandler
    PhoneNumberResponse:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: The unique identifier of the phone number.
        number:
          type: string
          description: The phone number in E.164 format.
        name:
          type:
            - string
            - 'null'
          description: >-
            The name given to the phone number. Helps to distinguish different
            phone numbers within your project.
        capabilities:
          type: array
          items:
            $ref: '#/components/schemas/PhoneNumberCapability'
          description: A list of communication methods this phone number supports.
        number_type:
          $ref: '#/components/schemas/PhoneNumberType'
          description: The type of number this is defined as.
        e911_address_id:
          oneOf:
            - $ref: '#/components/schemas/uuid'
            - type: 'null'
          description: The E911 address ID associated with this phone number.
        created_at:
          type: string
          format: date-time
          description: The date the number was added to your project.
        updated_at:
          type: string
          format: date-time
          description: The date the number was last updated.
        next_billed_at:
          type:
            - string
            - 'null'
          format: date-time
          description: The next date the number will be billed for.
        call_handler:
          oneOf:
            - $ref: '#/components/schemas/PhoneNumberCallHandler'
            - type: 'null'
          description: What type of handler you want to run on inbound calls.
        calling_handler_resource_id:
          oneOf:
            - $ref: '#/components/schemas/uuid'
            - type: 'null'
          description: The unique identifier of the calling handler resource.
        call_receive_mode:
          $ref: '#/components/schemas/CallReceiveMode'
          description: How do you want to receive the incoming call.
        call_request_url:
          type:
            - string
            - 'null'
          description: >-
            The URL to make a request to when using the laml_webhooks call
            handler.
        call_request_method:
          oneOf:
            - $ref: '#/components/schemas/HttpMethod'
            - type: 'null'
          description: >-
            The HTTP method to use when making a request to the
            call_request_url.
        call_fallback_url:
          type:
            - string
            - 'null'
          description: >-
            The fallback URL to make a request to when using the laml_webhooks
            call handler and the call_request_url fails.
        call_fallback_method:
          oneOf:
            - $ref: '#/components/schemas/HttpMethod'
            - type: 'null'
          description: >-
            The HTTP method to use when making a request to the
            call_fallback_url.
        call_status_callback_url:
          type:
            - string
            - 'null'
          description: >-
            The URL to make status callbacks to when using the laml_webhooks
            call handler.
        call_status_callback_method:
          oneOf:
            - $ref: '#/components/schemas/HttpMethod'
            - type: 'null'
          description: >-
            The HTTP method to use when making a request to the
            call_status_callback_url.
        call_laml_application_id:
          type:
            - string
            - 'null'
          description: >-
            The ID of the LaML Application to use when using the
            laml_application call handler.
        call_dialogflow_agent_id:
          type:
            - string
            - 'null'
          description: >-
            The ID of the Dialogflow Agent to start when using the dialogflow
            call handler.
        call_relay_topic:
          type:
            - string
            - 'null'
          description: >-
            A string representing the Relay topic to forward incoming calls to.
            This is only used (and required) when call_handler is set to
            relay_topic.
        call_relay_topic_status_callback_url:
          type:
            - string
            - 'null'
          description: >-
            A string representing a URL to send status change messages to. This
            is only used (and required) when call_handler is set to relay_topic.
        call_relay_script_url:
          type:
            - string
            - 'null'
          description: >-
            The URL to make a request to when using the relay_script call
            handler. The URL must respond with a valid SWML script.
        call_relay_context:
          type:
            - string
            - 'null'
          description: >-
            The name of the Relay Context to send this call to when using the
            relay_context call handler.
        call_relay_context_status_callback_url:
          type:
            - string
            - 'null'
          description: >-
            A string representing a URL to send status change messages to. This
            is only used (and required) when call_handler is set to
            relay_context.
        call_relay_application:
          type:
            - string
            - 'null'
          description: >-
            The name of the Relay Application to send this call to when using
            the relay_application call handler.
        call_relay_connector_id:
          type:
            - string
            - 'null'
          description: >-
            The ID of the Relay Connector to send this call to when using the
            relay_connector call handler.
        call_sip_endpoint_id:
          oneOf:
            - $ref: '#/components/schemas/uuid'
            - type: 'null'
          description: >-
            The ID of the Relay SIP Endpoint to send this call to when using the
            relay_sip_endpoint call handler.
        call_verto_resource:
          type:
            - string
            - 'null'
          description: >-
            The name of the Verto Relay Endpoint to send this call to when using
            the relay_verto_endpoint call handler.
        call_video_room_id:
          oneOf:
            - $ref: '#/components/schemas/uuid'
            - type: 'null'
          description: >-
            The ID of the Video Room to send this call to when using the
            video_room call handler.
        message_handler:
          oneOf:
            - $ref: '#/components/schemas/PhoneNumberMessageHandler'
            - type: 'null'
          description: What type of handler you want to run on inbound messages.
        messaging_handler_resource_id:
          oneOf:
            - $ref: '#/components/schemas/uuid'
            - type: 'null'
          description: The unique identifier of the messaging handler resource.
        message_request_url:
          type:
            - string
            - 'null'
          description: >-
            The URL to make a request to when using the laml_webhooks message
            handler.
        message_request_method:
          oneOf:
            - $ref: '#/components/schemas/HttpMethod'
            - type: 'null'
          description: >-
            The HTTP method to use when making a request to the
            message_request_url.
        message_fallback_url:
          type:
            - string
            - 'null'
          description: >-
            The fallback URL to make a request to when using the laml_webhooks
            message handler and the message_request_url fails.
        message_fallback_method:
          oneOf:
            - $ref: '#/components/schemas/HttpMethod'
            - type: 'null'
          description: >-
            The HTTP method to use when making a request to the
            message_fallback_url.
        message_laml_application_id:
          type:
            - string
            - 'null'
          description: >-
            The ID of the LaML Application to use when using the
            laml_application message handler.
        message_relay_topic:
          type:
            - string
            - 'null'
          description: >-
            The name of the Relay Topic to send this message to when using the
            relay_topic message handler.
        message_relay_context:
          type:
            - string
            - 'null'
          description: >-
            The name of the Relay Context to send this message to when using the
            relay_context message handler.
        country_code:
          type:
            - string
            - 'null'
          description: The ISO 3166-1 alpha-2 country code of the phone number.
      required:
        - id
        - number
        - name
        - capabilities
        - number_type
        - e911_address_id
        - created_at
        - updated_at
        - next_billed_at
        - call_handler
        - calling_handler_resource_id
        - call_receive_mode
        - call_request_url
        - call_request_method
        - call_fallback_url
        - call_fallback_method
        - call_status_callback_url
        - call_status_callback_method
        - call_laml_application_id
        - call_dialogflow_agent_id
        - call_relay_topic
        - call_relay_topic_status_callback_url
        - call_relay_script_url
        - call_relay_context
        - call_relay_context_status_callback_url
        - call_relay_application
        - call_relay_connector_id
        - call_sip_endpoint_id
        - call_verto_resource
        - call_video_room_id
        - message_handler
        - messaging_handler_resource_id
        - message_request_url
        - message_request_method
        - message_fallback_url
        - message_fallback_method
        - message_laml_application_id
        - message_relay_topic
        - message_relay_context
        - country_code
      description: Response containing a single phone number.
      title: PhoneNumberResponse
    TypesStatusCodesStatusCode401Error:
      type: string
      enum:
        - Unauthorized
      title: TypesStatusCodesStatusCode401Error
    Types.StatusCodes.StatusCode401:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode401Error'
      required:
        - error
      description: Access is unauthorized.
      title: Types.StatusCodes.StatusCode401
    Types.StatusCodes.SpaceApiErrorItem:
      type: object
      properties:
        detail:
          type: string
          description: A description of what caused the error.
        status:
          type: string
          description: The HTTP status code.
        title:
          type: string
          description: A short summary of the error type.
        code:
          type: string
          description: The error code.
      required:
        - detail
        - status
        - title
        - code
      description: Details about a specific validation error.
      title: Types.StatusCodes.SpaceApiErrorItem
    Types.StatusCodes.ValidationError:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Types.StatusCodes.SpaceApiErrorItem'
          description: List of validation errors.
      required:
        - errors
      description: The request failed validation. See errors for details.
      title: Types.StatusCodes.ValidationError
    TypesStatusCodesStatusCode500Error:
      type: string
      enum:
        - Internal Server Error
      title: TypesStatusCodesStatusCode500Error
    Types.StatusCodes.StatusCode500:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode500Error'
      required:
        - error
      description: An internal server error occurred.
      title: Types.StatusCodes.StatusCode500
  securitySchemes:
    SignalWireBasicAuth:
      type: http
      scheme: basic
      description: >-
        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)

        ```

```

## SDK Code Examples

```python
import requests

url = "https://your_space.signalwire.com/api/relay/rest/imported_phone_numbers"

payload = {
    "number": "+49152234333323",
    "number_type": "longcode"
}
headers = {
    "Authorization": "Basic <project_id>:<api_token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://your_space.signalwire.com/api/relay/rest/imported_phone_numbers';
const options = {
  method: 'POST',
  headers: {
    Authorization: 'Basic <project_id>:<api_token>',
    'Content-Type': 'application/json'
  },
  body: '{"number":"+49152234333323","number_type":"longcode"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your_space.signalwire.com/api/relay/rest/imported_phone_numbers"

	payload := strings.NewReader("{\n  \"number\": \"+49152234333323\",\n  \"number_type\": \"longcode\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <project_id>:<api_token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://your_space.signalwire.com/api/relay/rest/imported_phone_numbers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <project_id>:<api_token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"number\": \"+49152234333323\",\n  \"number_type\": \"longcode\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://your_space.signalwire.com/api/relay/rest/imported_phone_numbers")
  .header("Authorization", "Basic <project_id>:<api_token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"number\": \"+49152234333323\",\n  \"number_type\": \"longcode\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your_space.signalwire.com/api/relay/rest/imported_phone_numbers', [
  'body' => '{
  "number": "+49152234333323",
  "number_type": "longcode"
}',
  'headers' => [
    'Authorization' => 'Basic <project_id>:<api_token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://your_space.signalwire.com/api/relay/rest/imported_phone_numbers");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Basic <project_id>:<api_token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"number\": \"+49152234333323\",\n  \"number_type\": \"longcode\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Basic <project_id>:<api_token>",
  "Content-Type": "application/json"
]
let parameters = [
  "number": "+49152234333323",
  "number_type": "longcode"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://your_space.signalwire.com/api/relay/rest/imported_phone_numbers")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```