Management APIReferenceRules

GetRules

View as Markdown

Gets the rules.

Allowed roles: Owner, Admin, Developer, Supervisor, Call list manager, Support.

Example request: Get the first rule for the template 74951234567.

Authentication

AuthorizationBearer
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.

Query parameters

application_idintegerOptional

The application ID. Required unless application_name is provided.

application_namestringOptional

The application name. Required unless application_id is provided.

rule_idintegerOptional
The rule ID to filter
rule_namestringOptional
The rule name part to filter
video_conferencebooleanOptional
Whether it is a video conference to filter
attached_key_idstringOptional

The service account ID bound to the rule. Read more in the guide

templatestringOptional
Search for template matching
with_scenariosbooleanOptional
Whether to get bound scenarios info
countintegerOptionalDefaults to 20
The max returning record count
offsetintegerOptionalDefaults to 0

The first N records are skipped in the output

Response

Successful response
resultlist of objects
total_countinteger
The total found rule count
countinteger
The returned rule count