> This is a page from the ElevenLabs documentation. For a complete page index, fetch https://elevenlabs.io/docs/llms.txt. For the full documentation in a single file, fetch https://elevenlabs.io/docs/llms-full.txt. # Import phone number POST https://api.elevenlabs.io/v1/convai/phone-numbers Content-Type: application/json Import Phone Number from provider configuration (Twilio, Exotel, or SIP trunk) Reference: https://elevenlabs.io/docs/eleven-agents/api-reference/phone-numbers/create ## Servers - `https://api.elevenlabs.io` (Production, default) - `https://api.us.elevenlabs.io` (Production US) - `https://api.eu.residency.elevenlabs.io` (Production EU) - `https://api.in.residency.elevenlabs.io` (Production India) - `https://api.sg.residency.elevenlabs.io` (Production Singapore) ## Request ### Body (application/json) This endpoint expects a PhoneNumbersCreateRequestBody. - `PhoneNumbersCreateRequestBody` - `provider`: `twilio` - `label` (string, required) — Label for the phone number - `phone_number` (string, required) — Phone number - `sid` (string, required) — Twilio Account SID (starts with `AC`) or API Key SID (starts with `SK`) - `token` (string, required) — Secret paired with `sid`: the Account Auth Token for an Account SID, or the API Key Secret for an API Key SID - `account_auth_token` (string, optional) — Twilio Account Auth Token, required for API Key imports to validate inbound webhook signatures - `agent_id` (string, optional) — Agent ID to assign the phone number to - `enable_sms` (boolean, optional, default: true) — Route inbound SMS to ElevenLabs. On by default; set to false to skip SMS configuration for numbers that don't support it. - `region_config` (RegionConfigRequest, optional) — Twilio Additional Region Configuration - `supports_inbound` (boolean, optional, default: true, deprecated) — This field is deprecated and will be removed in the future. Whether this phone number supports inbound calls - `supports_outbound` (boolean, optional, default: true, deprecated) — This field is deprecated and will be removed in the future. Whether this phone number supports outbound calls - `provider`: `exotel` - `account_sid` (string, required) — Exotel Account SID - `api_key` (string, required) — Exotel API Key - `api_subdomain` (enum, required) — Exotel region-specific API host - Allowed values: `api.in.exotel.com`, `api.exotel.com` - `api_token` (string, required) — Exotel API Token - `app_id` (string, required) — Exotel applet identifier used in Calls/connect - `label` (string, required) — Label for the phone number - `phone_number` (string, required) — Phone number - `agent_id` (string, optional) — Agent ID to assign the phone number to - `applet_url` (string, optional) — Optional full applet URL override. Defaults to Exotel start_voice URL derived from account SID and app ID. - `supports_inbound` (boolean, optional, default: true, deprecated) — This field is deprecated and will be removed in the future. Whether this phone number supports inbound calls - `supports_outbound` (boolean, optional, default: true, deprecated) — This field is deprecated and will be removed in the future. Whether this phone number supports outbound calls - `provider`: `sip_trunk` - `label` (string, required) — Label for the phone number - `phone_number` (string, required) — Phone number - `agent_id` (string, optional) — Agent ID to assign the phone number to - `inbound_trunk_config` (InboundSipTrunkConfigRequestModel, optional) - `outbound_trunk_config` (OutboundSipTrunkConfigRequestModel, optional) - `supports_inbound` (boolean, optional, default: true, deprecated) — This field is deprecated and will be removed in the future. Whether this phone number supports inbound calls - `supports_outbound` (boolean, optional, default: true, deprecated) — This field is deprecated and will be removed in the future. Whether this phone number supports outbound calls ## Response ### 200 Successful Response - `phone_number_id` (string, required) — Phone entity ID ## Errors ### 422 Phone Numbers Create Request Unprocessable Entity Error Validation Error - `detail` (list of ValidationError, optional) ## Types ### RegionConfigRequest - `region_id` (enum, required) — Region ID - Allowed values: `us1`, `ie1`, `au1` - `token` (string, required) — Auth Token for this region - `edge_location` (enum, required) — Edge location for this region - Allowed values: `ashburn`, `dublin`, `frankfurt`, `sao-paulo`, `singapore`, `sydney`, `tokyo`, `umatilla`, `roaming` ### InboundSipTrunkConfigRequestModel - `allowed_addresses` (list of string, optional) — List of IP addresses that are allowed to use the trunk. Each item in the list can be an individual IP address or a Classless Inter-Domain Routing notation representing a CIDR block. - `allowed_numbers` (list of string, optional) — List of phone numbers that are allowed to use the trunk. - `media_encryption` (enum, optional, default: allowed) — Whether or not to encrypt media (data layer). - Allowed values: `disabled`, `allowed`, `required` - `credentials` (SipTrunkCredentialsRequestModel, optional) — Optional digest authentication credentials (username/password). - `remote_domains` (list of string, optional) — Domains of remote SIP servers used to validate TLS certificates. - `attributes_to_headers` (map from string to string, optional) — Map of dynamic variable name to header name for attributes_to_headers ### OutboundSipTrunkConfigRequestModel - `address` (string, required) — Hostname or IP the SIP INVITE is sent to. - `transport` (enum, optional, default: auto) — Protocol to use for SIP transport (signalling layer). - Allowed values: `auto`, `udp`, `tcp`, `tls` - `media_encryption` (enum, optional, default: allowed) — Whether or not to encrypt media (data layer). - Allowed values: `disabled`, `allowed`, `required` - `headers` (map from string to string, optional) — SIP X-* headers for INVITE request. These headers are sent as-is and may help identify this call. - `attributes_to_headers` (map from string to string, optional) — Map of dynamic variable name to header name for attributes_to_headers - `credentials` (SipTrunkCredentialsRequestModel, optional) — Optional digest authentication credentials (username/password). If not provided, ACL authentication is assumed. - `enabled_codecs` (list of enum, optional) — Media codecs that should be offered in the SDP for outbound calls. If empty, all supported codecs are offered. - Allowed values: `G722/8000`, `PCMU/8000`, `PCMA/8000` ### ValidationError - `loc` (list of ValidationErrorLocItem, required) - `msg` (string, required) - `type` (string, required) ### SipTrunkCredentialsRequestModel - `username` (string, required) — SIP trunk username - `password` (string, optional) — SIP trunk password - if not specified, then remain unchanged ### ValidationErrorLocItem ## Examples **Request** ```json { "provider": "twilio", "label": "label", "phone_number": "phone_number", "sid": "sid", "token": "token" } ``` **Response** ```json { "phone_number_id": "phone_number_id" } ``` **SDK Code** ```python import requests url = "https://api.elevenlabs.io/v1/convai/phone-numbers" payload = { "provider": "twilio", "label": "label", "phone_number": "phone_number", "sid": "sid", "token": "token" } headers = {"Content-Type": "application/json"} response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.elevenlabs.io/v1/convai/phone-numbers'; const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"provider":"twilio","label":"label","phone_number":"phone_number","sid":"sid","token":"token"}' }; 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://api.elevenlabs.io/v1/convai/phone-numbers" payload := strings.NewReader("{\n \"provider\": \"twilio\",\n \"label\": \"label\",\n \"phone_number\": \"phone_number\",\n \"sid\": \"sid\",\n \"token\": \"token\"\n}") req, _ := http.NewRequest("POST", url, payload) 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://api.elevenlabs.io/v1/convai/phone-numbers") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Content-Type"] = 'application/json' request.body = "{\n \"provider\": \"twilio\",\n \"label\": \"label\",\n \"phone_number\": \"phone_number\",\n \"sid\": \"sid\",\n \"token\": \"token\"\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.elevenlabs.io/v1/convai/phone-numbers") .header("Content-Type", "application/json") .body("{\n \"provider\": \"twilio\",\n \"label\": \"label\",\n \"phone_number\": \"phone_number\",\n \"sid\": \"sid\",\n \"token\": \"token\"\n}") .asString(); ``` ```php request('POST', 'https://api.elevenlabs.io/v1/convai/phone-numbers', [ 'body' => '{ "provider": "twilio", "label": "label", "phone_number": "phone_number", "sid": "sid", "token": "token" }', 'headers' => [ 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.elevenlabs.io/v1/convai/phone-numbers"); var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"provider\": \"twilio\",\n \"label\": \"label\",\n \"phone_number\": \"phone_number\",\n \"sid\": \"sid\",\n \"token\": \"token\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Content-Type": "application/json"] let parameters = [ "provider": "twilio", "label": "label", "phone_number": "phone_number", "sid": "sid", "token": "token" ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.elevenlabs.io/v1/convai/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() ``` > ElevenLabs provides APIs and SDKs for text to speech, voice cloning, speech to text, sound effects, voice isolator, voice changer, and conversational AI agents. Build voice-enabled applications with lifelike audio generation.