NSns-api
Auto Attendant

Read Auto Attendants

Changed on
get/domains/{domain}/autoattendants

Request

  • Base URL
    https://ns-api.com/ns-api/v2
  • URL
    https://ns-api.com/ns-api/v2/domains/{domain}/autoattendants
  • Auth
    HTTP bearer

Path parameters

domainstring required

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. Then using in path for GET you can set to "~" to use the domain name linked to your token/key instead of the domain name itself when reading for your own domain.

Example:example.com

Response

attendant-namestring required

This is the main name for the auto attendant. Should be used to explain the main purpose for the auto attendant.

userstring required
time-framestring
starting-promptstring

This is a "id" of sorts making this auto attendant unique in terms of this user and dial plan. Will be needed when reading details on a specific AA or making any modifications including removal.

read-pathstring

Shown only on a read of multiple auto attendants, will assist in getting the path for reading specific Attendant details.

Changes

  • bce16087d479Revision changes
    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status