List user hold messages

GET

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

Last modified:2026-10-09 00:32:43

OperationId:ReadMsgUser

Lists the hold messages of a user, in index order. They are stored beside the user's music on hold (MoH) files.

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 up to 100 messages by default; page with limit and start. Count them with GET /domains/{domain}/users/{user}/msg/count. file-access-url is a signed link that plays the file with no token, for 24 hours by default; see GET /domains/{domain}/users/{user}/msg/{index}/play.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Query Params

Responses

🟢200OK

application/json

The hold messages, in index order. An owner with none answers an empty array.

Bodyapplication/json

🟠400Bad Request

🟠401Authentication Required

🟠404Record not found

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/domains//users//msg?limit=undefined&start=undefined' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Hold messages

An uploaded message and a text-to-speech message.

[
    {
        "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": ""
    },
    {
        "filename": "msg-02.wav",
        "ordinal-order": 2,
        "file-duration-seconds": 7,
        "file-size-kilobytes": "54.69 KB",
        "created-datetime": "2026-09-01T14:30:00+00:00",
        "file-script-text": "Your call is important to us. Please stay on the line.",
        "file-source": "",
        "text-to-speech-voice-id": "en-US-Wavenet-C",
        "text-to-speech-language": "en-US"
    }
]

Modified at 2026-10-09 00:32:43

Play domain hold message

Count user hold messages