PortSIP Knowledge Base

Action urls

PreviousDestroy NextDestroy

Was this helpful?

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.

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

4XX

{
  "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.

Body

namestring · min: 1 · max: 64

The name of action url.

enabledboolean

Whether to enable or not.

headersstring

The request headers of action url.

caller_maskstring · max: 255

The caller mask of action url.

dtmf_maskstring · max: 255

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 · default: 2

The connection timeout in seconds.

request_timeoutinteger · int32 · default: 2

The request timeout in seconds.

typestring · enum

The action url type.
Can be either:

DTMF:
CALLER

Options: DTMF, CALLER

methodstring · enum

The action url request method.
Can be either:

GET
POST:

Options: GET, POST

enabledboolean

Enabled this event or not.

usernamestring · min: 6 · max: 64

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

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

passwordstring · min: 6 · max: 64

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 · min: 1 · max: 128

The event url.

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

authstring · enum · default: DISABLE

The authentication method of event URL:
Can be either:

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

Options: DISABLE, BASIC, DIGEST, BEARER

Responses

application/json

cURL

JavaScript

Python

HTTP

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 '{"connection_timeout":2,"request_timeout":2,"type":"DTMF","method":"GET","enabled":false,"auth":"DISABLE"}'

201

4XX

{
  "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.

url_idall ofrequired

The unique ID of action url.

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

4XX

{
  "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.

url_idall ofrequired

The unique ID of action url.

Body

namestring · min: 1 · max: 64

The name of action url.

enabledboolean

Whether to enable or not.

caller_maskstring · max: 255

The caller mask of action url.

dtmf_maskstring · max: 255

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

headersstring

The request headers of action url.

connection_timeoutinteger · int32 · default: 2

The connection timeout in seconds.

request_timeoutinteger · int32 · default: 2

The request timeout in seconds.

typestring · enum

The action url type.
Can be either:

DTMF:
CALLER

Options: DTMF, CALLER

methodstring · enum

The action url request method.
Can be either:

GET
POST:

Options: GET, POST

enabledboolean

Enabled this event or not.

usernamestring · min: 6 · max: 64

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

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

passwordstring · min: 6 · max: 64

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 · min: 1 · max: 128

The event url.

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

authstring · enum · default: DISABLE

The authentication method of event URL:
Can be either:

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

Options: DISABLE, BASIC, DIGEST, BEARER

Responses

cURL

JavaScript

Python

HTTP

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 '{"connection_timeout":2,"request_timeout":2,"type":"DTMF","method":"GET","enabled":false,"auth":"DISABLE"}'

200

4XX

No body

OK