Action urls
Retrieves a list of action urls of virtual receptionist.
Authorizations
Path parameters
idall ofRequired
The unique ID of virtual receptionist.
stringOptionalExample:
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200
OK
application/json
4XX
Error
get
GET /api/ivrs/{id}/action_urls HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"items": [
{
"id": "NzAwNTUxOTA5NzczMTQ4MTYw",
"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 for virtual receptionist.
Authorizations
Path parameters
idall ofRequired
The unique ID of virtual receptionist.
stringOptionalExample:
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
Body
all ofOptional
Responses
201
OK
application/json
4XX
Error
post
POST /api/ivrs/{id}/action_urls HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 241
{
"name": "text",
"enabled": false,
"type": "DTMF",
"method": "GET",
"headers": "text",
"caller_mask": "text",
"dtmf_mask": "text",
"connection_timeout": 2,
"request_timeout": 2,
"auth": "DISABLE",
"username": "text",
"password": "text",
"token": "text",
"url": "text"
}
{
"id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}
Retrieve details of action url of virtual receptionist.
Authorizations
Path parameters
idall ofRequired
The unique ID of virtual receptionist.
stringOptionalExample:
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
url_idall ofRequired
The unique ID of action url.
stringOptionalExample:
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200
OK
application/json
Responseall of
4XX
Error
get
GET /api/ivrs/{id}/action_urls/{url_id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "NzAwNTUxOTA5NzczMTQ4MTYw",
"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"
}
Set action url of virtual receptionist.
Authorizations
Path parameters
idall ofRequired
The unique ID of virtual receptionist.
stringOptionalExample:
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
url_idall ofRequired
The unique ID of action url.
stringOptionalExample:
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
Body
all ofOptional
Responses
200
OK
4XX
Error
post
POST /api/ivrs/{id}/action_urls/{url_id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 241
{
"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"
}
No content