Read domain hold message

GET

/domains/{domain}/msg/{index}

Last modified:2026-10-30 21:01:00

OperationId:ReadMsgFileDomain

Reads one of the domain's hold messages by its index, with a signed file-access-url that plays it. Requires Office Manager, Site Manager, Call Center Supervisor, Route Manager, Reseller, or Super User scope.

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, as a single object.

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//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-10-30 21:01:00

Delete domain hold message

Play domain hold message