> Fetch clean Markdown by appending `.md` to any page URL under https://signalwire.com/docs or requesting it with the HTTP header `Accept: text/markdown`. The root index at https://signalwire.com/docs/llms.txt lists the available documentation indexes. # Deploy call flow version POST https://%7BYour_Space_Name%7D.signalwire.com/api/fabric/resources/call_flow/{id}/versions Content-Type: application/json Makes one saved Call Flow version active, selected by document version or version ID. Use it after updating a visual flow when that revision is ready to handle calls; updating the Call Flow saves a revision but does not replace this deployment step. Directly authored [SWML Scripts](/docs/apis/rest/swml-scripts/create-swml-script) do not use Call Flow versions. #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space). Reference: https://signalwire.com/docs/apis/rest/call-flows/deploy-call-flow-version ## Authentication - `Authorization` header (basic auth, required) — 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) ``` ## Request ### Path parameters - `id` (string, required) — The unique identifier of the Call Flow. ### Body (application/json) This endpoint expects a CallFlowVersionDeployRequest. - `CallFlowVersionDeployRequest` ## Response ### 201 The request has succeeded and a new resource has been created as a result. - `id` (string, required) — The unique identifier of the deployed Call Flow Version. - `created_at` (string, required) — The creation timestamp. - `updated_at` (string, required) — The last update timestamp. - `document_version` (integer, required) — The document version. - `flow_data` (CallFlowVersionDeployResponseFlowData, optional) — Call Flow Builder state, stored as an opaque JSON object. - `relayml` (CallFlowVersionDeployResponseRelayml, optional) — The calling SWML document deployed by this version. Uses [calling SWML methods](/docs/swml/reference/calling). ## Errors ### 401 Unauthorized Error Access is unauthorized. - `error` (enum, required) - Allowed values: `Unauthorized` ### 404 Not Found Error The server cannot find the requested resource. - `error` (enum, required) - Allowed values: `Not Found` ### 422 Unprocessable Entity Error The request contains invalid parameters. See errors for details. - `errors` (list of Types.StatusCodes.RestApiErrorItem, required) — List of validation errors. ### 500 Internal Server Error An internal server error occurred. - `error` (enum, required) - Allowed values: `Internal Server Error` ## Types ### CallFlowVersionDeployByDocumentVersion - `document_version` (integer, required) — The current revision of the call flow. ### CallFlowVersionDeployByVersionId - `call_flow_version_id` (string, required) — Any call flow version ID for this call flow. ### CallFlowVersionDeployResponseFlowData Call Flow Builder state, stored as an opaque JSON object. ### CallFlowVersionDeployResponseRelayml The calling SWML document deployed by this version. Uses [calling SWML methods](/docs/swml/reference/calling). ### Types.StatusCodes.RestApiErrorItem Details about a specific error. - `type` (string, required) — The category of error. - `code` (string, required) — A specific error code. - `message` (string, required) — A description of what caused the error. - `url` (string, required) — A link to documentation about this error. - `attribute` (string, optional, nullable) — The request parameter that caused the error, if applicable. ## Examples **Request** ```json { "document_version": 2 } ``` **Response** ```json { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "created_at": "2024-05-06T12:20:00Z", "updated_at": "2024-05-06T12:25:00Z", "document_version": 2, "flow_data": {}, "relayml": { "sections": { "main": [ { "play": { "url": "https://cdn.signalwire.com/swml/audio.mp3" } } ] }, "version": "1.0.0" } } ``` **SDK Code** ```python Deploy by document version import requests url = "https://{your_space_name}.signalwire.com/api/fabric/resources/call_flow/id/versions" payload = { "document_version": 2 } headers = { "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers, auth=("", "")) print(response.json()) ``` ```javascript Deploy by document version const url = 'https://{your_space_name}.signalwire.com/api/fabric/resources/call_flow/id/versions'; const credentials = btoa(":"); const options = { method: 'POST', headers: { Authorization: `Basic ${credentials}`, 'Content-Type': 'application/json' }, body: '{"document_version":2}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Deploy by document version package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://{your_space_name}.signalwire.com/api/fabric/resources/call_flow/id/versions" payload := strings.NewReader("{\n \"document_version\": 2\n}") req, _ := http.NewRequest("POST", url, payload) req.SetBasicAuth("", "") 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 Deploy by document version require 'uri' require 'net/http' url = URI("https://{your_space_name}.signalwire.com/api/fabric/resources/call_flow/id/versions") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request.basic_auth("", "") request["Content-Type"] = 'application/json' request.body = "{\n \"document_version\": 2\n}" response = http.request(request) puts response.read_body ``` ```java Deploy by document version import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://{your_space_name}.signalwire.com/api/fabric/resources/call_flow/id/versions") .basicAuth("", "") .header("Content-Type", "application/json") .body("{\n \"document_version\": 2\n}") .asString(); ``` ```php Deploy by document version request('POST', 'https://{your_space_name}.signalwire.com/api/fabric/resources/call_flow/id/versions', [ 'body' => '{ "document_version": 2 }', 'headers' => [ 'Content-Type' => 'application/json', ], 'auth' => ['', ''], ]); echo $response->getBody(); ``` ```csharp Deploy by document version using RestSharp; using RestSharp.Authenticators; var client = new RestClient("https://{your_space_name}.signalwire.com/api/fabric/resources/call_flow/id/versions"); client.Authenticator = new HttpBasicAuthenticator("", ""); var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"document_version\": 2\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Deploy by document version import Foundation let credentials = Data(":".utf8).base64EncodedString() let headers = [ "Authorization": "Basic \(credentials)", "Content-Type": "application/json" ] let parameters = ["document_version": 2] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://{your_space_name}.signalwire.com/api/fabric/resources/call_flow/id/versions")! 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() ```