flexisip-account-manager/flexiapi/resources/views/api/documentation/accounts/voicemail.blade.php
2025-12-11 16:27:32 +00:00

57 lines
No EOL
1.7 KiB
PHP

## Voicemails
### `GET /accounts/{id/me}/voicemails`
<span class="badge badge-warning">Admin</span>
<span class="badge badge-info">User</span>
Return the currently stored voicemails
### `GET /accounts/{id/me}/voicemails/{uuid}`
<span class="badge badge-warning">Admin</span>
<span class="badge badge-info">User</span>
```
{
id: '{uuid}',
sip_from: '{sip_address}',
get_url: 'https://{the file_url}',
file_size: 2451400, // the file size, in bytes
content_type: 'audio/{format}',
created_at: '2025-10-09T12:59:32Z',
uploaded_at: '2025-10-09T12:59:40Z'
}
```
Return a stored voicemail
### `POST /accounts/{id/me}/voicemails`
<span class="badge badge-warning">Admin</span>
<span class="badge badge-info">User</span>
Create a new voicemail slot
JSON parameters:
* `sip_from`, mandatory, a valid SIP address
* `content_type`, mandatory, the content type of the audio file to upload, must be `audio/opus` or `audio/wav`
This endpoint will return the following JSON:
```
{
id: '{uuid}',
sip_from: '{sip_address}',
upload_url: 'https://{upload_service_unique_url}', // unique URL generated to upload the audio file
download_url: 'https://{download_service_unique_url}', // unique URL generated to download the audio file, null before upload
max_upload_size: 3000000, // here 3MB file size limit, in bytes
content_type: 'audio/{format}',
created_at: '2025-10-09T12:59:32Z', // time of the slot creation
uploaded_at: null // time when the slot was filled with the audio file
}
```
### `DELETE /accounts/{id/me}/voicemails/{uuid}`
<span class="badge badge-warning">Admin</span>
<span class="badge badge-info">User</span>
Delete a stored voicemail, if the file is managed by the platform it will be deleted as well