> For a complete documentation index, fetch https://docs.voximplant.ai/llms.txt # AddRule POST https://api.voximplant.com/platform_api/AddRule Adds a new rule for the application. Allowed roles: `Owner`, `Admin`, `Developer`. **Example request:** Add a new rule. Reference: https://docs.voximplant.ai/api-reference/management-api/reference/rules/add-rule ## Authentication - `Authorization` header (bearer token, required) — Voximplant Management API uses signed JWT tokens generated from your service-account private key. Pass the token in the `Authorization` header as a Bearer value: ``` Authorization: Bearer $VOXIMPLANT_TOKEN ``` See [Authorization](/api-reference/management-api/authorization) for ready-to-copy snippets in bash, Python, Node.js and Go that turn your `credentials.json` into a token. ## Request ### Query parameters - `application_id` (integer, optional) — The application ID. **Required** unless **application_name** is provided. - `application_name` (string, optional) — The application name. **Required** unless **application_id** is provided. - `rule_name` (string, required) — The rule name. The length must be less than 100 - `rule_pattern` (string, required) — The rule pattern regex. The length must be less than 64 KB - `rule_pattern_exclude` (string, optional) — The exclude pattern regex. The length must be less than 64 KB - `video_conference` (boolean, optional, default: false) — Whether video conference is required - `bind_key_id` (string, optional) — The service account ID to bind to the rule. Read more in the [guide](/platform/voxengine/management-api-usage) - `scenario_id` (list of integer, optional) — The scenario ID list separated by semicolons (;). **Required** unless **scenario_name** is provided. - `scenario_name` (list of string, optional) — The scenario name list separated by semicolons (;). **Required** unless **scenario_id** is provided. ## Response ### 200 Successful response - `result` (integer, optional) — Returns 1 if the request has been completed successfully - `rule_id` (integer, optional) — The new rule ID ## Examples **Request** ```json {} ``` **Response** ```json { "result": 1, "rule_id": 789 } ``` **SDK Code** ```python Example 1 import requests url = "https://api.voximplant.com/platform_api/AddRule" querystring = {"rule_name":"BlockSpamCalls","rule_pattern":"^\\+1(800|900)\\d{7}$","application_id":"12345","rule_pattern_exclude":"^\\+18005551234$","video_conference":"false","bind_key_id":"svc-account-98765","scenario_id":"[101,102]"} payload = {} headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers, params=querystring) print(response.json()) ``` ```javascript Example 1 const url = 'https://api.voximplant.com/platform_api/AddRule?rule_name=BlockSpamCalls&rule_pattern=%5E%5C%2B1%28800%7C900%29%5Cd%7B7%7D%24&application_id=12345&rule_pattern_exclude=%5E%5C%2B18005551234%24&video_conference=false&bind_key_id=svc-account-98765&scenario_id=%5B101%2C102%5D'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Example 1 package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.voximplant.com/platform_api/AddRule?rule_name=BlockSpamCalls&rule_pattern=%5E%5C%2B1%28800%7C900%29%5Cd%7B7%7D%24&application_id=12345&rule_pattern_exclude=%5E%5C%2B18005551234%24&video_conference=false&bind_key_id=svc-account-98765&scenario_id=%5B101%2C102%5D" payload := strings.NewReader("{}") 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 Example 1 require 'uri' require 'net/http' url = URI("https://api.voximplant.com/platform_api/AddRule?rule_name=BlockSpamCalls&rule_pattern=%5E%5C%2B1%28800%7C900%29%5Cd%7B7%7D%24&application_id=12345&rule_pattern_exclude=%5E%5C%2B18005551234%24&video_conference=false&bind_key_id=svc-account-98765&scenario_id=%5B101%2C102%5D") 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 = "{}" response = http.request(request) puts response.read_body ``` ```java Example 1 import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.voximplant.com/platform_api/AddRule?rule_name=BlockSpamCalls&rule_pattern=%5E%5C%2B1%28800%7C900%29%5Cd%7B7%7D%24&application_id=12345&rule_pattern_exclude=%5E%5C%2B18005551234%24&video_conference=false&bind_key_id=svc-account-98765&scenario_id=%5B101%2C102%5D") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php Example 1 request('POST', 'https://api.voximplant.com/platform_api/AddRule?rule_name=BlockSpamCalls&rule_pattern=%5E%5C%2B1%28800%7C900%29%5Cd%7B7%7D%24&application_id=12345&rule_pattern_exclude=%5E%5C%2B18005551234%24&video_conference=false&bind_key_id=svc-account-98765&scenario_id=%5B101%2C102%5D', [ 'body' => '{}', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp Example 1 using RestSharp; var client = new RestClient("https://api.voximplant.com/platform_api/AddRule?rule_name=BlockSpamCalls&rule_pattern=%5E%5C%2B1%28800%7C900%29%5Cd%7B7%7D%24&application_id=12345&rule_pattern_exclude=%5E%5C%2B18005551234%24&video_conference=false&bind_key_id=svc-account-98765&scenario_id=%5B101%2C102%5D"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Example 1 import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.voximplant.com/platform_api/AddRule?rule_name=BlockSpamCalls&rule_pattern=%5E%5C%2B1%28800%7C900%29%5Cd%7B7%7D%24&application_id=12345&rule_pattern_exclude=%5E%5C%2B18005551234%24&video_conference=false&bind_key_id=svc-account-98765&scenario_id=%5B101%2C102%5D")! 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() ```