> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.conversive.ai/api-sdk-docs/initiate-call/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.conversive.ai/_mcp/server. # Initiate Call POST https://app.beconversive.com/contact-center/v1/calls/initiate Content-Type: application/json Start a new outbound call. Two calling modes are available — choose the one that fits your integration. - **Browser calling** — the response includes a LiveKit `token` and `livekit_url`. Pass these to your WebRTC client immediately so the agent can join the call from a browser tab. - **Phone-bridge calling** — the platform dials the agent's configured phone number first, then bridges to the customer. `token` and `livekit_url` are returned as `null`. Reference: https://docs.conversive.ai/api-sdk-docs/initiate-call ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Request ### Body (application/json) This endpoint expects an object. - `phone_number` (string, required) — Customer number to dial in E.164 format, e.g. `+919580440262`. - `from_number` (string, required) — Business number used as the caller ID. Must belong to the authenticated account. - `contact_name` (string, optional) — Optional display name for the contact. - `use_agent_phone` (boolean, optional, default: false) — `false` — agent joins via browser (default). `true` — platform calls the agent's phone and bridges to the customer. ## Response ### 200 Call successfully initiated. - `call_id` (string, optional) — Unique ID of the created call. **Save this — it is required for all follow-up operations.** - `room_name` (string, optional) — LiveKit room name created for this call. Required for call action requests. - `token` (string, optional, nullable) — LiveKit browser-join token. Present only when `agent_join_via_phone` is `false`. - `livekit_url` (string, optional, nullable) — LiveKit server WebSocket URL. Present only when `agent_join_via_phone` is `false`. - `agent_join_via_phone` (boolean, optional) — Reflects the calling mode that was used. ## Errors ### 400 Bad Request Error Invalid account or user context, invalid `from_number`, or missing agent phone configuration. - `any` ### 401 Unauthorized Error Unauthorized — missing or invalid JWT. - `any` ### 500 Internal Server Error Internal error — call setup failed. - `any` ## Examples ### 200 OK — Browser flow **Request** ```json { "phone_number": "+14155552671", "from_number": "+14155550000", "use_agent_phone": true } ``` **Response** ```json { "call_id": "550e8400-e29b-41d4-a716-446655440000", "room_name": "cc_outbound_550e8400-e29b-41d4-a716-446655440000", "token": null, "livekit_url": null, "agent_join_via_phone": true } ``` **SDK Code** ```python 200 OK — Browser flow import requests url = "https://app.beconversive.com/contact-center/v1/calls/initiate" payload = { "phone_number": "+14155552671", "from_number": "+14155550000", "use_agent_phone": True } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript 200 OK — Browser flow const url = 'https://app.beconversive.com/contact-center/v1/calls/initiate'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"phone_number":"+14155552671","from_number":"+14155550000","use_agent_phone":true}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go 200 OK — Browser flow package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://app.beconversive.com/contact-center/v1/calls/initiate" payload := strings.NewReader("{\n \"phone_number\": \"+14155552671\",\n \"from_number\": \"+14155550000\",\n \"use_agent_phone\": true\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") 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 200 OK — Browser flow require 'uri' require 'net/http' url = URI("https://app.beconversive.com/contact-center/v1/calls/initiate") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"phone_number\": \"+14155552671\",\n \"from_number\": \"+14155550000\",\n \"use_agent_phone\": true\n}" response = http.request(request) puts response.read_body ``` ```java 200 OK — Browser flow import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://app.beconversive.com/contact-center/v1/calls/initiate") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"phone_number\": \"+14155552671\",\n \"from_number\": \"+14155550000\",\n \"use_agent_phone\": true\n}") .asString(); ``` ```php 200 OK — Browser flow request('POST', 'https://app.beconversive.com/contact-center/v1/calls/initiate', [ 'body' => '{ "phone_number": "+14155552671", "from_number": "+14155550000", "use_agent_phone": true }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp 200 OK — Browser flow using RestSharp; var client = new RestClient("https://app.beconversive.com/contact-center/v1/calls/initiate"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"phone_number\": \"+14155552671\",\n \"from_number\": \"+14155550000\",\n \"use_agent_phone\": true\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift 200 OK — Browser flow import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "phone_number": "+14155552671", "from_number": "+14155550000", "use_agent_phone": true ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://app.beconversive.com/contact-center/v1/calls/initiate")! 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() ``` ### 200 OK — Phone-bridge flow **Request** ```json { "phone_number": "+14155552671", "from_number": "+14155550000", "use_agent_phone": true } ``` **Response** ```json { "call_id": "550e8400-e29b-41d4-a716-446655440000", "room_name": "cc_outbound_550e8400-e29b-41d4-a716-446655440000", "token": null, "livekit_url": null, "agent_join_via_phone": true } ``` **SDK Code** ```python 200 OK — Phone-bridge flow import requests url = "https://app.beconversive.com/contact-center/v1/calls/initiate" payload = { "phone_number": "+14155552671", "from_number": "+14155550000", "use_agent_phone": True } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript 200 OK — Phone-bridge flow const url = 'https://app.beconversive.com/contact-center/v1/calls/initiate'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"phone_number":"+14155552671","from_number":"+14155550000","use_agent_phone":true}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go 200 OK — Phone-bridge flow package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://app.beconversive.com/contact-center/v1/calls/initiate" payload := strings.NewReader("{\n \"phone_number\": \"+14155552671\",\n \"from_number\": \"+14155550000\",\n \"use_agent_phone\": true\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") 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 200 OK — Phone-bridge flow require 'uri' require 'net/http' url = URI("https://app.beconversive.com/contact-center/v1/calls/initiate") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"phone_number\": \"+14155552671\",\n \"from_number\": \"+14155550000\",\n \"use_agent_phone\": true\n}" response = http.request(request) puts response.read_body ``` ```java 200 OK — Phone-bridge flow import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://app.beconversive.com/contact-center/v1/calls/initiate") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"phone_number\": \"+14155552671\",\n \"from_number\": \"+14155550000\",\n \"use_agent_phone\": true\n}") .asString(); ``` ```php 200 OK — Phone-bridge flow request('POST', 'https://app.beconversive.com/contact-center/v1/calls/initiate', [ 'body' => '{ "phone_number": "+14155552671", "from_number": "+14155550000", "use_agent_phone": true }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp 200 OK — Phone-bridge flow using RestSharp; var client = new RestClient("https://app.beconversive.com/contact-center/v1/calls/initiate"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"phone_number\": \"+14155552671\",\n \"from_number\": \"+14155550000\",\n \"use_agent_phone\": true\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift 200 OK — Phone-bridge flow import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "phone_number": "+14155552671", "from_number": "+14155550000", "use_agent_phone": true ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://app.beconversive.com/contact-center/v1/calls/initiate")! 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() ``` ### Browser calling **Request** ```json { "phone_number": "+14155552671", "from_number": "+14155550000", "use_agent_phone": true } ``` **Response** ```json { "call_id": "550e8400-e29b-41d4-a716-446655440000", "room_name": "cc_outbound_550e8400-e29b-41d4-a716-446655440000", "token": null, "livekit_url": null, "agent_join_via_phone": true } ``` **SDK Code** ```python Browser calling import requests url = "https://app.beconversive.com/contact-center/v1/calls/initiate" payload = { "phone_number": "+14155552671", "from_number": "+14155550000", "use_agent_phone": True } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript Browser calling const url = 'https://app.beconversive.com/contact-center/v1/calls/initiate'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"phone_number":"+14155552671","from_number":"+14155550000","use_agent_phone":true}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Browser calling package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://app.beconversive.com/contact-center/v1/calls/initiate" payload := strings.NewReader("{\n \"phone_number\": \"+14155552671\",\n \"from_number\": \"+14155550000\",\n \"use_agent_phone\": true\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") 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 Browser calling require 'uri' require 'net/http' url = URI("https://app.beconversive.com/contact-center/v1/calls/initiate") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"phone_number\": \"+14155552671\",\n \"from_number\": \"+14155550000\",\n \"use_agent_phone\": true\n}" response = http.request(request) puts response.read_body ``` ```java Browser calling import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://app.beconversive.com/contact-center/v1/calls/initiate") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"phone_number\": \"+14155552671\",\n \"from_number\": \"+14155550000\",\n \"use_agent_phone\": true\n}") .asString(); ``` ```php Browser calling request('POST', 'https://app.beconversive.com/contact-center/v1/calls/initiate', [ 'body' => '{ "phone_number": "+14155552671", "from_number": "+14155550000", "use_agent_phone": true }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp Browser calling using RestSharp; var client = new RestClient("https://app.beconversive.com/contact-center/v1/calls/initiate"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"phone_number\": \"+14155552671\",\n \"from_number\": \"+14155550000\",\n \"use_agent_phone\": true\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Browser calling import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "phone_number": "+14155552671", "from_number": "+14155550000", "use_agent_phone": true ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://app.beconversive.com/contact-center/v1/calls/initiate")! 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() ``` ### Phone-bridge calling **Request** ```json { "phone_number": "+14155552671", "from_number": "+14155550000", "use_agent_phone": true } ``` **Response** ```json { "call_id": "550e8400-e29b-41d4-a716-446655440000", "room_name": "cc_outbound_550e8400-e29b-41d4-a716-446655440000", "token": null, "livekit_url": null, "agent_join_via_phone": true } ``` **SDK Code** ```python Phone-bridge calling import requests url = "https://app.beconversive.com/contact-center/v1/calls/initiate" payload = { "phone_number": "+14155552671", "from_number": "+14155550000", "use_agent_phone": True } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript Phone-bridge calling const url = 'https://app.beconversive.com/contact-center/v1/calls/initiate'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"phone_number":"+14155552671","from_number":"+14155550000","use_agent_phone":true}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Phone-bridge calling package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://app.beconversive.com/contact-center/v1/calls/initiate" payload := strings.NewReader("{\n \"phone_number\": \"+14155552671\",\n \"from_number\": \"+14155550000\",\n \"use_agent_phone\": true\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") 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 Phone-bridge calling require 'uri' require 'net/http' url = URI("https://app.beconversive.com/contact-center/v1/calls/initiate") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"phone_number\": \"+14155552671\",\n \"from_number\": \"+14155550000\",\n \"use_agent_phone\": true\n}" response = http.request(request) puts response.read_body ``` ```java Phone-bridge calling import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://app.beconversive.com/contact-center/v1/calls/initiate") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"phone_number\": \"+14155552671\",\n \"from_number\": \"+14155550000\",\n \"use_agent_phone\": true\n}") .asString(); ``` ```php Phone-bridge calling request('POST', 'https://app.beconversive.com/contact-center/v1/calls/initiate', [ 'body' => '{ "phone_number": "+14155552671", "from_number": "+14155550000", "use_agent_phone": true }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp Phone-bridge calling using RestSharp; var client = new RestClient("https://app.beconversive.com/contact-center/v1/calls/initiate"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"phone_number\": \"+14155552671\",\n \"from_number\": \"+14155550000\",\n \"use_agent_phone\": true\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Phone-bridge calling import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "phone_number": "+14155552671", "from_number": "+14155550000", "use_agent_phone": true ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://app.beconversive.com/contact-center/v1/calls/initiate")! 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() ```