Read auto attendant

GET

/domains/{domain}/users/{user}/autoattendants/{prompt}

Last modified:2026-10-09 00:29:27

OperationId:ReadSpecificAutoAttendant

Returns one auto attendant: its name, starting tier, greetings, and what every key does, with submenus in full.

Requires Office Manager, Site Manager, Reseller, or Super User scope. A Site Manager can read only attendants of users in their site.

Each greeting has a file-access-url that plays it without a token until it expires. A tier with no greeting has an empty audio array. A submenu's greeting sits beside its auto-attendant, and an attendant with intro greetings lists them in intro-greetings, one per time frame.

A {prompt} that is not one of the user's attendants returns 404. To find an attendant's {prompt}, use List auto attendants in domain.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Responses

🟢200OK

application/json

The auto attendant.

Bodyapplication/json

🟠401Authentication Required

🟠403Forbidden

🟠404Record not found

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/domains//users/8000/autoattendants/Prompt_100' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Main menu

{
    "attendant-name": "Main Menu",
    "user": "8000",
    "starting-prompt": "Prompt_100",
    "time-frame": "*",
    "audio": {
        "filename": "greeting-100.wav",
        "ordinal-order": 100,
        "file-duration-seconds": 6,
        "file-size-kilobytes": "46.88 KB",
        "created-datetime": "2026-09-01T14:30:00+00:00",
        "file-access-url": "https://core1.example.com/ns-api/v2/domains/example.com/users/8000/greetings/100/play?expires=1790000000&signature=Qm9y3Yp0n1kT8w0xR2c4ZbV6fLh5sJd7gA9eN3uWq1M",
        "file-script-text": "Thank you for calling. For sales, press 1. For support, press 2. For the operator, press 0.",
        "file-source": "",
        "text-to-speech-voice-id": "en-US-Wavenet-C",
        "text-to-speech-language": "en-US"
    },
    "auto-attendant": {
        "3-digit-dial-by-extension": "no",
        "4-digit-dial-by-extension": "yes",
        "5-digit-dial-by-extension": "no",
        "no-key-press": "option-0",
        "unassigned-key-press": "repeat",
        "option-1": {
            "description": "Sales",
            "destination-application": "to-callqueue",
            "destination-user": "2000"
        },
        "option-2": {
            "description": "Support",
            "auto-attendant": {
                "3-digit-dial-by-extension": "no",
                "4-digit-dial-by-extension": "no",
                "5-digit-dial-by-extension": "no",
                "no-key-press": "repeat",
                "unassigned-key-press": "repeat",
                "option-1": {
                    "description": "Billing",
                    "destination-application": "to-user",
                    "destination-user": "1002"
                },
                "option-9": {
                    "description": "Repeat",
                    "destination-application": "repeat-tier"
                }
            },
            "audio": {
                "filename": "greeting-102.wav",
                "ordinal-order": 102,
                "file-duration-seconds": 4,
                "file-size-kilobytes": "31.25 KB",
                "created-datetime": "2026-09-01T14:30:00+00:00",
                "file-access-url": "https://core1.example.com/ns-api/v2/domains/example.com/users/8000/greetings/102/play?expires=1790000000&signature=Qm9y3Yp0n1kT8w0xR2c4ZbV6fLh5sJd7gA9eN3uWq1M",
                "file-script-text": "For billing, press 1. To hear these options again, press 9.",
                "file-source": "",
                "text-to-speech-voice-id": "en-US-Wavenet-C",
                "text-to-speech-language": "en-US"
            }
        },
        "option-0": {
            "description": "Operator",
            "destination-application": "to-user",
            "destination-user": "1001"
        }
    }
}

Modified at 2026-10-09 00:29:27

List auto attendants in domain

Update auto attendant