Action urls

List action urls

Retrieves a list of action urls of virtual receptionist.

get

/ivrs/{id}/action_urls

Authorizations

Path parameters

idall ofrequired

The unique ID of virtual receptionist.

The unique ID of the resource.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://HOSTNAME:8887/api/ivrs/{id}/action_urls' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

200

{
  "items": [
    {
      "name": "text",
      "enabled": false,
      "caller_mask": "text",
      "dtmf_mask": "text",
      "headers": "text",
      "connection_timeout": 2,
      "request_timeout": 2,
      "type": "DTMF",
      "method": "GET",
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "username": "text",
      "password": "text",
      "token": "text",
      "url": "text",
      "auth": "DISABLE"
    }
  ]
}

OK

Create an action url

Create an action url for virtual receptionist.

post

/ivrs/{id}/action_urls

Authorizations

Path parameters

idall ofrequired

The unique ID of virtual receptionist.

The unique ID of the resource.

Body

all of

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/ivrs/{id}/action_urls' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "enabled": false,
    "headers": "text",
    "caller_mask": "text",
    "dtmf_mask": "text",
    "connection_timeout": 2,
    "request_timeout": 2,
    "type": "DTMF",
    "method": "GET",
    "username": "text",
    "password": "text",
    "token": "text",
    "url": "text",
    "auth": "DISABLE"
  }'

201

4XX

201

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

OK

Retrieve action url

Retrieve details of action url of virtual receptionist.

get

/ivrs/{id}/action_urls/{url_id}

Authorizations

Path parameters

idall ofrequired

The unique ID of virtual receptionist.

The unique ID of the resource.

url_idall ofrequired

The unique ID of action url.

The unique ID of the resource.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://HOSTNAME:8887/api/ivrs/{id}/action_urls/{url_id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

200

{
  "name": "text",
  "enabled": false,
  "caller_mask": "text",
  "dtmf_mask": "text",
  "headers": "text",
  "connection_timeout": 2,
  "request_timeout": 2,
  "type": "DTMF",
  "method": "GET",
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "username": "text",
  "password": "text",
  "token": "text",
  "url": "text",
  "auth": "DISABLE"
}

OK

Update action url

Set action url of virtual receptionist.

post

/ivrs/{id}/action_urls/{url_id}

Authorizations

Path parameters

idall ofrequired

The unique ID of virtual receptionist.

The unique ID of the resource.

url_idall ofrequired

The unique ID of action url.

The unique ID of the resource.

Body

all of

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/ivrs/{id}/action_urls/{url_id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "enabled": false,
    "caller_mask": "text",
    "dtmf_mask": "text",
    "headers": "text",
    "connection_timeout": 2,
    "request_timeout": 2,
    "type": "DTMF",
    "method": "GET",
    "username": "text",
    "password": "text",
    "token": "text",
    "url": "text",
    "auth": "DISABLE"
  }'

200

4XX

200

No body

OK