Action urls

List action urls

get

Retrieves a list of action urls of virtual receptionist.

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": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "name": "text",
      "enabled": true,
      "type": "DTMF",
      "caller_mask": "text",
      "dtmf_mask": "text",
      "method": "GET",
      "headers": "text",
      "connection_timeout": 1,
      "request_timeout": 1,
      "auth": "DISABLE",
      "username": "text",
      "password": "text",
      "token": "text",
      "url": "text"
    }
  ]
}

OK

Create an action url

post

Create an action url for virtual receptionist.

Authorizations

Path parameters

idall ofrequired

The unique ID of virtual receptionist.

The unique ID of the resource.

Body

all ofoptional

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": true,
    "type": "DTMF",
    "method": "GET",
    "headers": "text",
    "caller_mask": "text",
    "dtmf_mask": "text",
    "connection_timeout": 1,
    "request_timeout": 1,
    "auth": "DISABLE",
    "username": "text",
    "password": "text",
    "token": "text",
    "url": "text"
  }'

201

4XX

201

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

OK

Retrieve action url

get

Retrieve details of action url of virtual receptionist.

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

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

OK

Update action url

post

Set action url of virtual receptionist.

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 ofoptional

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": true,
    "type": "DTMF",
    "caller_mask": "text",
    "dtmf_mask": "text",
    "method": "GET",
    "headers": "text",
    "connection_timeout": 1,
    "request_timeout": 1,
    "auth": "DISABLE",
    "username": "text",
    "password": "text",
    "token": "text",
    "url": "text"
  }'

200

4XX

200

No body

OK