Ivrs | PortSIP Knowledge Base

Lists virtual receptionists

Retrieve a collection of virtual receptionists.

GEThttp://127.0.0.1:8888/api/ivrs

Query parameters

Response

OK

Body

countinteger (int64)

Total number of resource.

Example: 100

itemsarray of object

Request

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

Response

{
  "count": 100,
  "items": [
    {
      "id": {},
      "name": "text",
      "extension_number": "text"
    }
  ]
}

Create a virtual receptionist.

Add a new virtual receptionist into system.

POSThttp://127.0.0.1:8888/api/ivrs

Body

name*string

The name of virtual receptionist.

extension_number*string

The extension number.

Pattern: [0-9]{3,64}

languagestring

BCP 47 Language Tags (The Internet Best Current Practices (BCP) for language tags). A language tag is composed of a sequence of one or more subtags such as language, region, variant and script subtags. When a language tag is comprised of more than one subtag, the subtag values are separated by the "-" character. You will most commonly find language tags written with 2 subtags - language and region. For example: en-US.

Example: "en-US"

dtmf_intervalinteger (int32)

The time to wait for the next DTMF input.

prompt_file_idall of

The unique ID of the file.

transfer_prompt_file_idall of

The unique ID of the file.

enable_pinboolean

Whether the PIN is required for DISA.

pin*string

The PIN number for accessing.
The PIN policies include:

A sequence of numbers 6-10 digits in length.
No repeating numbers (e.g. "111", "222")
No sequential numbers (e.g. "012", "789")

timeout_forward_ruleobject

failure_forward_ruleobject

custom_forward_rulesarray of object

outbound_caller_idsarray of object

A collection of outbound caller IDs.

Response

OK

Body

idall of

The unique ID of virtual receptionist.

Request

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

Response

{
  "id": {}
}

Retrieve a virtual receptionist

Retrieve virtual receptionists server by it's unique ID.

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

Path parameters

id*string

The unique ID of the resource.

Example: "NzAwNTUxOTA5NzczMTQ4MTYw"

Response

OK

Body

idall of

The unique ID of virtual receptionist.

namestring

The name of virtual receptionist.

extension_numberstring

The extension number.

Pattern: [0-9]{3,64}

languagestring

BCP 47 Language Tags (The Internet Best Current Practices (BCP) for language tags). A language tag is composed of a sequence of one or more subtags such as language, region, variant and script subtags. When a language tag is comprised of more than one subtag, the subtag values are separated by the "-" character. You will most commonly find language tags written with 2 subtags - language and region. For example: en-US.

Example: "en-US"

dtmf_intervalinteger (int32)

The time to wait for the next DTMF input.

prompt_file_namestring

The name of the file.

prompt_file_sizeinteger (int64)

The file size in bytes.

Example: 0

prompt_file_urlstring

The relative path to file url for file downloading.

Example: "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK"

transfer_prompt_file_namestring

The name of the file.

transfer_prompt_file_sizeinteger (int64)

The file size in bytes.

Example: 0

transfer_prompt_file_urlstring

The relative path to file url for file downloading.

Example: "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK"

enable_pinboolean

Whether the PIN is required for DISA.

pinstring

The PIN number for accessing.
The PIN policies include:

A sequence of numbers 6-10 digits in length.
No repeating numbers (e.g. "111", "222")
No sequential numbers (e.g. "012", "789")

timeout_forward_ruleobject

failure_forward_ruleobject

custom_forward_rulesarray of object

outbound_caller_idsarray of object

A collection of outbound caller IDs.

Request

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

Response

{
  "id": {},
  "name": "text",
  "extension_number": "text",
  "language": "en-US",
  "prompt_file_name": "text",
  "prompt_file_size": 0,
  "prompt_file_url": "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK",
  "transfer_prompt_file_name": "text",
  "transfer_prompt_file_size": 0,
  "transfer_prompt_file_url": "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK",
  "enable_pin": true,
  "pin": "text",
  "timeout_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text"
  },
  "failure_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text"
  },
  "custom_forward_rules": [
    {
      "user_input": "text",
      "office_hours": {
        "mode": "CUSTOM",
        "monday": {
          "enabled": false,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "tuesday": {
          "enabled": false,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "wednesday": {
          "enabled": false,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "thursday": {
          "enabled": false,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "friday": {
          "enabled": false,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "saturday": {
          "enabled": false,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "sunday": {
          "enabled": false,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        }
      },
      "office_hours_forward_rule": {
        "action": "FORWARD_TO_NUMBER",
        "number": "text"
      },
      "non_office_hours_forward_rule": {
        "action": "FORWARD_TO_NUMBER",
        "number": "text"
      },
      "holidays": [
        {
          "id": {},
          "name": "text",
          "region": "text",
          "consecutive": false,
          "every_year": false
        }
      ],
      "holiday_forward_rule": {
        "action": "FORWARD_TO_NUMBER",
        "number": "text"
      }
    }
  ],
  "outbound_caller_ids": [
    {
      "provider_id": {},
      "caller_id": {},
      "description": "text"
    }
  ]
}

Update a virtual receptionist

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

Path parameters

id*all of

The unique ID of virtual receptionist.

Body

namestring

The name of virtual receptionist.

languagestring

BCP 47 Language Tags (The Internet Best Current Practices (BCP) for language tags). A language tag is composed of a sequence of one or more subtags such as language, region, variant and script subtags. When a language tag is comprised of more than one subtag, the subtag values are separated by the "-" character. You will most commonly find language tags written with 2 subtags - language and region. For example: en-US.

Example: "en-US"

dtmf_intervalinteger (int32)

The time to wait for the next DTMF input.

prompt_file_idall of

The unique ID of the file.

transfer_prompt_file_idall of

The unique ID of the file.

enable_pinboolean

Whether the PIN is required for DISA.

pinstring

The PIN number for accessing.
The PIN policies include:

A sequence of numbers 6-10 digits in length.
No repeating numbers (e.g. "111", "222")
No sequential numbers (e.g. "012", "789")

timeout_forward_ruleobject

failure_forward_ruleobject

custom_forward_rulesarray of object

outbound_caller_idsarray of object

A collection of outbound caller IDs.

Response

OK

Request

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