Sign in
latestOpenAPI 3.1.0PortSIP2026-08-105581112.6 MB

577415d4a3d5

Virtual Receptionist

Create an action url

Create an action url for virtual receptionist.

post/ivrs/{id}/action_urls

Path parameters

idstring required

The unique ID of the resource.

Example:NzAwNTUxOTA5NzczMTQ4MTYw

The unique ID of the virtual receptionist.

Request body

namestring

The name of action url.

enabledboolean

Enabled this event or not.

type'DTMF' | 'CALLER'

The action url type.
Can be either:

  • DTMF:
  • CALLER
method'GET' | 'POST'

The action url request method.
Can be either:

  • GET
  • POST:
headersstring

The request headers of action url.

caller_maskstring

The caller mask of action url.

dtmf_maskstring

The DTMF mask of action url.
A semicolon-separated list of DTMF number or DTMF number range.
For example: 1000;2000;3000-4000.

connection_timeoutinteger

The connection timeout in seconds.

request_timeoutinteger

The request timeout in seconds.

auth'DISABLE' | 'BASIC' | 'DIGEST' | 'BEARER'

The authentication method of event URL:
Can be either:

  • DISABLE: Disable authentication.
  • BASIC: Use basic authentication.
  • DIGEST: Use digest authentication.
  • BEARER: Use bearer authentication.
usernamestring

The username for authentication, when auth is BASIC or DIGEST.

passwordstring

The password for authentication, when auth is BASIC or DIGEST.

tokenstring

The token for authentication, when auth is BEARER.

urlstring

The event url.

Response

OK

idstring

The unique ID of the resource.

Example response

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}