Action urls

List action urls

Retrieves a list of action urls of virtual receptionist.

GEThttp://127.0.0.1:8888/api/ivrs/{id}/action_urls

Path parameters

id*all of

The unique ID of virtual receptionist.

Response

2004XX

OK

Body

application/json

itemsarray of all of

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/ivrs/{id}/action_urls', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Create an action url

Create an action url for virtual receptionist.

POSThttp://127.0.0.1:8888/api/ivrs/{id}/action_urls

Path parameters

id*all of

The unique ID of virtual receptionist.

Body

application/json

namestring

The name of action url.

enabledboolean

Whether to enable or not.

typeenum

The action url type.
Can be either:

• DTMF:
• CALLER

DTMFCALLER

methodenum

The action url request method.
Can be either:

• GET
• POST:

GETPOST

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 (int32)

The connection timeout in seconds.

request_timeoutinteger (int32)

The request timeout in seconds.

enabledboolean

Enabled this event or not.

authenum

The authentication method of event URL:
Can be either:

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

DISABLEBASICDIGESTBEARER

usernamestring

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

Pattern: [a-z0-9]{6,64}

passwordstring

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

Pattern: [a-z0-9]{6,64}

tokenstring

The token for authentication, when auth is BEARER.

urlstring

The event url.

Pattern: [a-z0-9]{6,64}

Response

2014XX

OK

Body

application/json

idall of

The unique ID of action url.

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/ivrs/{id}/action_urls', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201

{
  "id": {}
}

Retrieve action url

Retrieve details of action url of virtual receptionist.

GEThttp://127.0.0.1:8888/api/ivrs/{id}/action_urls/{url_id}

Path parameters

id*all of

The unique ID of virtual receptionist.

url_id*all of

The unique ID of action url.

Response

2004XX

OK

Body

application/json

idall of

The unique ID of action url.

namestring

The name of action url.

enabledboolean

Whether to enable or not.

typeenum

The action url type.
Can be either:

• DTMF:
• CALLER

DTMFCALLER

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.

methodenum

The action url request method.
Can be either:

• GET
• POST:

GETPOST

headersstring

The request headers of action url.

connection_timeoutinteger (int32)

The connection timeout in seconds.

request_timeoutinteger (int32)

The request timeout in seconds.

enabledboolean

Enabled this event or not.

authenum

The authentication method of event URL:
Can be either:

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

DISABLEBASICDIGESTBEARER

usernamestring

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

Pattern: [a-z0-9]{6,64}

passwordstring

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

Pattern: [a-z0-9]{6,64}

tokenstring

The token for authentication, when auth is BEARER.

urlstring

The event url.

Pattern: [a-z0-9]{6,64}

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/ivrs/{id}/action_urls/{url_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Update action url

Set action url of virtual receptionist.

POSThttp://127.0.0.1:8888/api/ivrs/{id}/action_urls/{url_id}

Path parameters

id*all of

The unique ID of virtual receptionist.

url_id*all of

The unique ID of action url.

Body

application/json

namestring

The name of action url.

enabledboolean

Whether to enable or not.

typeenum

The action url type.
Can be either:

• DTMF:
• CALLER

DTMFCALLER

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.

methodenum

The action url request method.
Can be either:

• GET
• POST:

GETPOST

headersstring

The request headers of action url.

connection_timeoutinteger (int32)

The connection timeout in seconds.

request_timeoutinteger (int32)

The request timeout in seconds.

enabledboolean

Enabled this event or not.

authenum

The authentication method of event URL:
Can be either:

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

DISABLEBASICDIGESTBEARER

usernamestring

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

Pattern: [a-z0-9]{6,64}

passwordstring

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

Pattern: [a-z0-9]{6,64}

tokenstring

The token for authentication, when auth is BEARER.

urlstring

The event url.

Pattern: [a-z0-9]{6,64}

Response

2004XX

OK

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/ivrs/{id}/action_urls/{url_id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();