Read user hold message

GET

/domains/{domain}/users/{user}/msg/{index}

Last modified:2026-09-29 15:50:01

OperationId:ReadMsgFileUser

Reads one of a user's hold messages by its index.

Basic User, Advanced User, Simple User, and Call Center Agent can read their own hold messages. Office Manager, Site Manager, Call Center Supervisor, Route Manager, Reseller, and Super User can read any user's hold messages in the domain, as can Office Manager Read-Only and Super User Read Only.

Returns a single object, not an array. An index with no message returns 404. List every message with GET /domains/{domain}/users/{user}/msg. file-access-url is present only where a legacy playback link is configured; on a default installation it is left out.

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 hold message at index.

Bodyapplication/json

🟠400Bad Request

🟠401Authentication Required

🟠403Forbidden

🟠404Record not found

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/domains/example.com/users/1001/msg/1' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Hold message

Message 1.

{
    "filename": "msg-01.wav",
    "ordinal-order": 1,
    "file-duration-seconds": 12,
    "file-size-kilobytes": "93.75 KB",
    "created-datetime": "2026-09-01T14:30:00+00:00",
    "file-script-text": "Thank you for holding. Visit example.com for our current offers.",
    "file-source": "",
    "text-to-speech-voice-id": "",
    "text-to-speech-language": ""
}

Modified at 2026-09-29 15:50:01

Delete user hold message

List text-to-speech voices