# Manage Voicemails The BYON Voicemail API allows you to manage voicemails. It provides commands/endpoints for searching, retrieving, deleting, and updating the status of voicemails. ## Base URLs - For your base URL, use the production server `https://naas.t-mobile.com/cpaas` - to find your specific endpoint, go to your dashboard's subscription settings and retrieve the API endpoint. ## Authentication Like all other BYON requests, your calls require two headers for authentication: - `Authorization`: Bearer token (e.g., `Bearer `) - `X-Authorization`: PoP token generated for each request Additionally, include the `msisdn` header with the user's phone number in the format `tel:+14255551111`. ## Endpoints ### 1. Search Voicemails Search for voicemails based on criteria; you can search for voicemails received after a given date by setting ```minDate``` in the request body. ```bash curl -X POST "https://naas.t-mobile.com/cpaas/voicemails/v1/search" \ -H "Authorization: Bearer " \ -H "X-Authorization: " \ -H "msisdn: tel:+14255551111" \ -H "Content-Type: application/json" \ -d '{"minDate": "2023-08-12T00:00:00Z", "cursor": ""}' ``` ### 2. Get Voicemails by ID Retrieve a specific voicemail by its ID. Tip: do a full search first to determine the desired ID of the voicemail you want to retrieve. ```bash curl -X GET "https://naas.t-mobile.com/cpaas/voicemails/v1/{voicemailId}" \ -H "Authorization: Bearer " \ -H "X-Authorization: " \ -H "msisdn: tel:+14255551111" ``` ### 3. Delete Voicemail Delete a voicemail by its ID. ```bash curl -X DELETE "https://naas.t-mobile.com/cpaas/voicemails/v1/{voicemailId}" \ -H "Authorization: Bearer " \ -H "X-Authorization: " \ -H "msisdn: tel:+14255551111" ``` ### 4. Get Voicemail Payload Retrieve the audio file of a voicemail. ```bash curl -X GET "https://naas.t-mobile.com/cpaas/voicemails/v1/{voicemailId}/payload?audiotype=audio/amr" \ -H "Authorization: Bearer " \ -H "X-Authorization: " \ -H "msisdn: tel:+14255551111" ``` ### 5. Update Voicemail Status Update the status (flag) of a voicemail; it can be either **NEW**, meaning that it has not been played or has not been seen yet, or **SEEN**, meaning that is has been played or seen already. ```bash curl -X PUT "https://naas.t-mobile.com/cpaas/voicemails/v1/{voicemailId}/status" \ -H "Authorization: Bearer " \ -H "X-Authorization: " \ -H "msisdn: tel:+14255551111" \ -H "Content-Type: application/json" \ -d '{"flag": "SEEN"}' ``` ## Response Formats Successful responses return JSON data or binary audio files, while error responses include a JSON object with status, code, and message fields. Remember to replace ****, ****, and **{voicemailId}** with actual values in your requests. LC1.3-AUG14