Import numbers from your own carrier account

Imports only the selected numbers owned by the supplied phone connected service account. The number records are added to this workspace; inbound, outbound, and transfer routing use automatic outbound setup; incoming routing changes only when an inbound_agent_id is supplied. Inspect setup_errors and capability_readiness for partial failures. Requires a Sendora API key with write access. This operation can change workspace data or trigger an external side effect; review the request before sending it and do not retry blindly after a timeout.

POST

/

api

/

v1

/

public

/

phone-numbers

/

import

/

confirm

cURL

curl -X POST 'https://api.sendora.ai/api/v1/public/phone-numbers/import/confirm' -H "X-API-Key: $SENDORA_API_KEY" -H "Content-Type: application/json" \
  -d '{"api_key":"example","number_ids":["example"]}'

import requests

url = 'https://api.sendora.ai/api/v1/public/phone-numbers/import/confirm'
headers = {'X-API-Key': '$SENDORA_API_KEY'}
response = requests.post(url, headers=headers, json={'api_key': 'example', 'number_ids': ['example']})
response.raise_for_status()
print(response.json())

const response = await fetch("https://api.sendora.ai/api/v1/public/phone-numbers/import/confirm", {
  method: "POST",
  headers: { 'X-API-Key': process.env.SENDORA_API_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({"api_key": "example", "number_ids": ["example"]}),
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());

req, err := http.NewRequest("POST", "https://api.sendora.ai/api/v1/public/phone-numbers/import/confirm", bytes.NewBufferString(`{"api_key": "example", "number_ids": ["example"]}`))
if err != nil { log.Fatal(err) }
req.Header.Set("X-API-Key", os.Getenv("SENDORA_API_KEY"))
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

{
  "imported": [
    {
      "created_at": "<string>",
      "id": "<string>",
      "number": "<string>",
      "status": "<string>",
      "capability_readiness": {},
      "provisioning_state": "<string>",
      "source": "<string>",
      "supports_mms": true,
      "supports_sms": true,
      "supports_voice": true
    }
  ],
  "note": "<string>",
  "setup_errors": [
    {
      "message": "<string>",
      "number_id": "<string>"
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Customer API key created in the Sendora dashboard.

Headers

X-API-Key

string | null

Authorization

string | null

Body

application/json

api_key

string

required

API key for the phone connected service account being connected

Minimum string length: 10

number_ids

string[]

required

The numbers to import: id values from the import search results.

Minimum array length: 1

inbound_agent_id

string | null

The voice agent that answers incoming calls: an id from List voice agents.

outbound_voice_profile_id

string | null

The outbound calling profile to use: an id from Get outbound calling setup options.

Minimum string length: 1

Response

Successful Response

imported

PublicImportedNumber · object[]

required

Imported returned by the Sendora API.

Show child attributes

note

string

required

Note returned by the Sendora API.

setup_errors

connected serviceSetupError · object[]

Setup errors returned by the Sendora API.

Show child attributes

cURL

curl -X POST 'https://api.sendora.ai/api/v1/public/phone-numbers/import/confirm' -H "X-API-Key: $SENDORA_API_KEY" -H "Content-Type: application/json" \
  -d '{"api_key":"example","number_ids":["example"]}'

import requests

url = 'https://api.sendora.ai/api/v1/public/phone-numbers/import/confirm'
headers = {'X-API-Key': '$SENDORA_API_KEY'}
response = requests.post(url, headers=headers, json={'api_key': 'example', 'number_ids': ['example']})
response.raise_for_status()
print(response.json())

const response = await fetch("https://api.sendora.ai/api/v1/public/phone-numbers/import/confirm", {
  method: "POST",
  headers: { 'X-API-Key': process.env.SENDORA_API_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({"api_key": "example", "number_ids": ["example"]}),
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());

req, err := http.NewRequest("POST", "https://api.sendora.ai/api/v1/public/phone-numbers/import/confirm", bytes.NewBufferString(`{"api_key": "example", "number_ids": ["example"]}`))
if err != nil { log.Fatal(err) }
req.Header.Set("X-API-Key", os.Getenv("SENDORA_API_KEY"))
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

{
  "imported": [
    {
      "created_at": "<string>",
      "id": "<string>",
      "number": "<string>",
      "status": "<string>",
      "capability_readiness": {},
      "provisioning_state": "<string>",
      "source": "<string>",
      "supports_mms": true,
      "supports_sms": true,
      "supports_voice": true
    }
  ],
  "note": "<string>",
  "setup_errors": [
    {
      "message": "<string>",
      "number_id": "<string>"
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}