# Shared Voicemails

Manage your shared voicemail.

## List shared voicemails.

> Retrieve a collection of shared voicemails.<br>

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Shared Voicemail","description":"Manage your shared voicemail.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/shared_voicemails":{"get":{"tags":["Shared Voicemail"],"operationId":"listSharedVoicemails","summary":"List shared voicemails.","description":"Retrieve a collection of shared voicemails.\n","parameters":[{"name":"filter","in":"query","schema":{"type":"string"},"description":"Use the `filter` query parameter to retrieve just a subset of a collection.\n"},{"name":"search","in":"query","schema":{"type":"string"},"description":"Use the `search` query parameter to restrict the results of a request to match a search criterion.\n"},{"name":"orderby","in":"query","schema":{"type":"string"},"description":"Use the `orderby` query parameter to specify the sort order of the items returned from server.  \nThe default order is ascending order.\n"},{"name":"skip","in":"query","schema":{"type":"integer","format":"int32","minimum":0,"default":0},"description":"Use the `skip` query parameter to set the number of items to skip at the start of a collection.\n"},{"name":"top","in":"query","schema":{"type":"integer","format":"int32","minimum":1,"maximum":100,"default":100},"description":"Use the `top` query parameter to specify the page size of the result set.\n"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","format":"int64","minimum":0,"description":"Total number of resource.\n"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of shared voicemail.\n"},"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of shared voicemail.\n"},"extension_number":{"type":"string","minLength":3,"maxLength":64,"pattern":"[0-9]{3,64}","description":"The extension number.\n"},"prompt":{"allOf":[{"type":"string","description":"BCP 47 Language Tags (The Internet Best Current Practices (BCP) for language tags).\nA language tag is composed of a sequence of one or more subtags such as language, region, variant and script subtags.\nWhen a language tag is comprised of more than one subtag, the subtag values are separated by the \"-\" character.\nYou will most commonly find language tags written with 2 subtags - language and region. For example: en-US.\n"}],"description":"The prompt set name of shared voicemail.\n"},"enable_pin":{"type":"boolean","default":true,"description":"Whether the PIN is required to access shared voicemail.\n"},"pin":{"type":"string","minLength":6,"maxLength":10,"description":"The PIN number for accessing.   \nThe PIN policies include:  \n1. A sequence of numbers 6-10 digits in length.  \n2. No repeating numbers (e.g. \"111\", \"222\")\n3. No sequential numbers (e.g. \"012\", \"789\")\n"},"enable_email_notify":{"type":"boolean","default":false,"description":"Enable email notify or not.\n"},"recipients":{"type":"string","description":"Comma-separated list of email address that should receive notifications.   \nAllow up to 15 email addresses.\n"},"play_datetime":{"type":"string","enum":["DISABLE","12_HOUR_CLOCK","24_HOUR_CLOCK"],"description":"Announces Date and Time of Message.\n- `DISABLE`: Do not read;\n- `12_HOUR_CLOCK`: Read in 12-hour clock;\n- `24_HOUR_CLOCK`: Read in 24-hour clock.\n"}}}}}}}}},"4XX":{"description":"Error"}}}}}}
```

## Create a shared voicemail

> Add a new shared voicemail.<br>

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Shared Voicemail","description":"Manage your shared voicemail.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/shared_voicemails":{"post":{"tags":["Shared Voicemail"],"operationId":"createSharedVoicemail","summary":"Create a shared voicemail","description":"Add a new shared voicemail.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of shared voicemail.\n"},"extension_number":{"type":"string","minLength":3,"maxLength":64,"pattern":"[0-9]{3,64}","description":"The extension number.\n"},"prompt":{"allOf":[{"type":"string","description":"BCP 47 Language Tags (The Internet Best Current Practices (BCP) for language tags).\nA language tag is composed of a sequence of one or more subtags such as language, region, variant and script subtags.\nWhen a language tag is comprised of more than one subtag, the subtag values are separated by the \"-\" character.\nYou will most commonly find language tags written with 2 subtags - language and region. For example: en-US.\n"}],"description":"The prompt set name of shared voicemail.\n"},"enable_pin":{"type":"boolean","default":true,"description":"Whether the PIN is required to access shared voicemail.\n"},"pin":{"type":"string","minLength":6,"maxLength":10,"description":"The PIN number for accessing.   \nThe PIN policies include:  \n1. A sequence of numbers 6-10 digits in length.  \n2. No repeating numbers (e.g. \"111\", \"222\")\n3. No sequential numbers (e.g. \"012\", \"789\")\n"},"enable_email_notify":{"type":"boolean","default":false,"description":"Enable email notify or not.\n"},"recipients":{"type":"string","description":"Comma-separated list of email address that should receive notifications.   \nAllow up to 15 email addresses.\n"},"play_datetime":{"type":"string","enum":["DISABLE","12_HOUR_CLOCK","24_HOUR_CLOCK"],"description":"Announces Date and Time of Message.\n- `DISABLE`: Do not read;\n- `12_HOUR_CLOCK`: Read in 12-hour clock;\n- `24_HOUR_CLOCK`: Read in 24-hour clock.\n"}},"required":["name","extension_number","pin"]}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of shared voicemail.\n"}}}}}},"4XX":{"description":"Error"}}}}}}
```

## Retrieve a shared voicemail

> Retrieve shared voicemail by ID.<br>

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Shared Voicemail","description":"Manage your shared voicemail.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/shared_voicemails/{id}":{"get":{"tags":["Shared Voicemail"],"operationId":"retrieveSharedVoicemail","summary":"Retrieve a shared voicemail","description":"Retrieve shared voicemail by ID.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of shared voicemail.\n"},"description":"The unique ID of the shared voicemail."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of shared voicemail.\n"},"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of shared voicemail.\n"},"extension_number":{"type":"string","minLength":3,"maxLength":64,"pattern":"[0-9]{3,64}","description":"The extension number.\n"},"prompt":{"allOf":[{"type":"string","description":"BCP 47 Language Tags (The Internet Best Current Practices (BCP) for language tags).\nA language tag is composed of a sequence of one or more subtags such as language, region, variant and script subtags.\nWhen a language tag is comprised of more than one subtag, the subtag values are separated by the \"-\" character.\nYou will most commonly find language tags written with 2 subtags - language and region. For example: en-US.\n"}],"description":"The prompt set name of shared voicemail.\n"},"enable_pin":{"type":"boolean","default":true,"description":"Whether the PIN is required to access shared voicemail.\n"},"pin":{"type":"string","minLength":6,"maxLength":10,"description":"The PIN number for accessing.   \nThe PIN policies include:  \n1. A sequence of numbers 6-10 digits in length.  \n2. No repeating numbers (e.g. \"111\", \"222\")\n3. No sequential numbers (e.g. \"012\", \"789\")\n"},"enable_email_notify":{"type":"boolean","default":false,"description":"Enable email notify or not.\n"},"recipients":{"type":"string","description":"Comma-separated list of email address that should receive notifications.   \nAllow up to 15 email addresses.\n"},"play_datetime":{"type":"string","enum":["DISABLE","12_HOUR_CLOCK","24_HOUR_CLOCK"],"description":"Announces Date and Time of Message.\n- `DISABLE`: Do not read;\n- `12_HOUR_CLOCK`: Read in 12-hour clock;\n- `24_HOUR_CLOCK`: Read in 24-hour clock.\n"}}}}}},"4XX":{"description":"Error"}}}}}}
```

## Update a shared voicemail

> Update a shared voicemail<br>

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Shared Voicemail","description":"Manage your shared voicemail.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/shared_voicemails/{id}":{"post":{"tags":["Shared Voicemail"],"operationId":"updateSharedVoicemail","summary":"Update a shared voicemail","description":"Update a shared voicemail\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of shared voicemail.\n"},"description":"The unique ID of the shared voicemail."}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of shared voicemail.\n"},"prompt":{"allOf":[{"type":"string","description":"BCP 47 Language Tags (The Internet Best Current Practices (BCP) for language tags).\nA language tag is composed of a sequence of one or more subtags such as language, region, variant and script subtags.\nWhen a language tag is comprised of more than one subtag, the subtag values are separated by the \"-\" character.\nYou will most commonly find language tags written with 2 subtags - language and region. For example: en-US.\n"}],"description":"The prompt set name of shared voicemail.\n"},"enable_pin":{"type":"boolean","default":true,"description":"Whether the PIN is required to access shared voicemail.\n"},"pin":{"type":"string","minLength":6,"maxLength":10,"description":"The PIN number for accessing.   \nThe PIN policies include:  \n1. A sequence of numbers 6-10 digits in length.  \n2. No repeating numbers (e.g. \"111\", \"222\")\n3. No sequential numbers (e.g. \"012\", \"789\")\n"},"enable_email_notify":{"type":"boolean","default":false,"description":"Enable email notify or not.\n"},"recipients":{"type":"string","description":"Comma-separated list of email address that should receive notifications.   \nAllow up to 15 email addresses.\n"},"play_datetime":{"type":"string","enum":["DISABLE","12_HOUR_CLOCK","24_HOUR_CLOCK"],"description":"Announces Date and Time of Message.\n- `DISABLE`: Do not read;\n- `12_HOUR_CLOCK`: Read in 12-hour clock;\n- `24_HOUR_CLOCK`: Read in 24-hour clock.\n"}}}}}},"responses":{"200":{"description":"OK"},"4XX":{"description":"Error"}}}}}}
```

## Destroy a shared voicemail

> Destroy a shared voicemail<br>

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Shared Voicemail","description":"Manage your shared voicemail.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/shared_voicemails/{id}/destroy":{"post":{"tags":["Shared Voicemail"],"operationId":"deleteSharedVoicemail","summary":"Destroy a shared voicemail","description":"Destroy a shared voicemail\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of shared voicemail.\n"},"description":"The unique ID of the shared voicemail."}],"responses":{"204":{"description":"No Content"},"400":{"description":"Invalid ring group ID supplied."}}}}}}
```

## List shared voicemail mails

> Retrieve a collection of shared voicemail mails.<br>

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Shared Voicemail","description":"Manage your shared voicemail.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/shared_voicemails/{id}/voicemails":{"get":{"tags":["Shared Voicemail"],"operationId":"listSharedVoicemailMails","summary":"List shared voicemail mails","description":"Retrieve a collection of shared voicemail mails.\n","parameters":[{"name":"filter","in":"query","schema":{"type":"string"},"description":"Use the `filter` query parameter to retrieve just a subset of a collection.\n"},{"name":"search","in":"query","schema":{"type":"string"},"description":"Use the `search` query parameter to restrict the results of a request to match a search criterion.\n"},{"name":"orderby","in":"query","schema":{"type":"string"},"description":"Use the `orderby` query parameter to specify the sort order of the items returned from server.  \nThe default order is ascending order.\n"},{"name":"skip","in":"query","schema":{"type":"integer","format":"int32","minimum":0,"default":0},"description":"Use the `skip` query parameter to set the number of items to skip at the start of a collection.\n"},{"name":"top","in":"query","schema":{"type":"integer","format":"int32","minimum":1,"maximum":100,"default":100},"description":"Use the `top` query parameter to specify the page size of the result set.\n"},{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of shared voicemail.\n"},"description":"The unique ID of the shared voicemail."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","format":"int64","minimum":0,"description":"Total number of resource.\n"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of voicemail.\n"},"sender":{"type":"string","description":"The sender number of the voicemail.\n"},"created_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"The creation time of voicemail.\n"},"duration":{"type":"integer","format":"int32","description":"The playback time (in seconds).\n"},"status":{"type":"string","enum":["READ","UNREAD"],"description":"Status of the voicemail includes:\n- `READ`: read mail\n- `UNREAD`: unread mail\n"},"file_name":{"type":"string","description":"The name of the file.\n"},"file_size":{"type":"integer","format":"int64","minimum":0,"description":"The file size in bytes.\n"},"file_url":{"type":"string","readOnly":true,"description":"The relative path to file url for file downloading.\n"}}}}}}}}},"4XX":{"description":"Error"}}}}}}
```

## Retrieve a shared voicemail mail

> Retrieve shared voicemail mail details.<br>

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Shared Voicemail","description":"Manage your shared voicemail.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/shared_voicemails/{id}/voicemails/{mail_id}":{"get":{"tags":["Shared Voicemail"],"operationId":"retrieveSharedVoicemailMail","summary":"Retrieve a shared voicemail mail","description":"Retrieve shared voicemail mail details.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of shared voicemail.\n"},"description":"The unique ID of the shared voicemail."},{"name":"mail_id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of voicemail.\n"},"description":"The unique ID of voicemail."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of voicemail.\n"},"sender":{"type":"string","description":"The sender number of the voicemail.\n"},"created_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"The creation time of voicemail.\n"},"duration":{"type":"integer","format":"int32","description":"The playback time (in seconds).\n"},"status":{"type":"string","enum":["READ","UNREAD"],"description":"Status of the voicemail includes:\n- `READ`: read mail\n- `UNREAD`: unread mail\n"},"file_name":{"type":"string","description":"The name of the file.\n"},"file_size":{"type":"integer","format":"int64","minimum":0,"description":"The file size in bytes.\n"},"file_url":{"type":"string","readOnly":true,"description":"The relative path to file url for file downloading.\n"}}}}}},"4XX":{"description":"Error"}}}}}}
```

## Update shared voicemail mail status to read

> Update shared voicemail mail status to read<br>

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Shared Voicemail","description":"Manage your shared voicemail.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/shared_voicemails/{id}/voicemails/{mail_id}/set_read":{"post":{"tags":["Shared Voicemail"],"operationId":"setSharedVoicemailMailRead","summary":"Update shared voicemail mail status to read","description":"Update shared voicemail mail status to read\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of shared voicemail.\n"},"description":"The unique ID of the shared voicemail."},{"name":"mail_id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of voicemail.\n"},"description":"The unique ID of voicemail."}],"responses":{"200":{"description":"OK"},"400":{"description":"Invalid voicemail ID supplied"}}}}}}
```

## Update shared voicemail mail status to unread

> Update shared voicemail mail status to unread<br>

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Shared Voicemail","description":"Manage your shared voicemail.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/shared_voicemails/{id}/voicemails/{mail_id}/set_unread":{"post":{"tags":["Shared Voicemail"],"operationId":"setSharedVoicemailMailUnread","summary":"Update shared voicemail mail status to unread","description":"Update shared voicemail mail status to unread\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of shared voicemail.\n"},"description":"The unique ID of the shared voicemail."},{"name":"mail_id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of voicemail.\n"},"description":"The unique ID of voicemail."}],"responses":{"200":{"description":"OK"},"400":{"description":"Invalid voicemail ID supplied"}}}}}}
```

## Delete a shared voicemail mail

> Remove a mail from shared voicemail.<br>

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Shared Voicemail","description":"Manage your shared voicemail.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/shared_voicemails/{id}/voicemails/{mail_id}/destroy":{"post":{"tags":["Shared Voicemail"],"operationId":"deleteSharedVoicemailMail","summary":"Delete a shared voicemail mail","description":"Remove a mail from shared voicemail.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of shared voicemail.\n"},"description":"The unique ID of the shared voicemail."},{"name":"mail_id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of voicemail.\n"},"description":"The unique ID of voicemail."}],"responses":{"204":{"description":"No Content"},"400":{"description":"Invalid voicemail ID supplied"},"404":{"description":"User not found"}}}}}}
```

## List shared voicemail greetings

> Retrieves a collection of greetings of shared voicemail.<br>

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Shared Voicemail","description":"Manage your shared voicemail.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/shared_voicemails/{id}/greetings":{"get":{"tags":["Shared Voicemail"],"operationId":"listSharedVoicemailGreetings","summary":"List shared voicemail greetings","description":"Retrieves a collection of greetings of shared voicemail.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of shared voicemail.\n"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of greeting.\n"},"enabled":{"type":"boolean","description":"Whether the greeting is enabled or not.\n"},"file_name":{"type":"string","description":"The name of the file.\n"},"file_size":{"type":"integer","format":"int64","minimum":0,"description":"The file size in bytes.\n"},"file_url":{"type":"string","readOnly":true,"description":"The relative path to file url for file downloading.\n"}}}}}}}}},"4XX":{"description":"Error"}}}}}}
```

## Create voicemail greeting for shared voicemail

> Create voicemail greeting for shared voicemail.<br>

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Shared Voicemail","description":"Manage your shared voicemail.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/shared_voicemails/{id}/greetings":{"post":{"tags":["Shared Voicemail"],"operationId":"createGreetingForSharedVoicemail","summary":"Create voicemail greeting for shared voicemail","description":"Create voicemail greeting for shared voicemail.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of shared voicemail.\n"},"description":"The unique ID of the shared voicemail."}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"file_id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of the file.\n"}}}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of greeting.\n"}}}}}},"4XX":{"description":"Error"}}}}}}
```

## Enable one of shared voicemail's greetings.

> Set one of shared voicemail's greetings to activated state.<br>

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Shared Voicemail","description":"Manage your shared voicemail.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/shared_voicemails/{id}/greetings/{greeting_id}/enable":{"post":{"tags":["Shared Voicemail"],"operationId":"enableSharedVoicemailGreeting","summary":"Enable one of shared voicemail's greetings.","description":"Set one of shared voicemail's greetings to activated state.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of shared voicemail.\n"}},{"name":"greeting_id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of greeting.\n"}}],"responses":{"200":{"description":"OK"},"404":{"description":"User not found"}}}}}}
```

## Disable shared voicemail greeting

> Disable shared voicemail greeting by it's unique ID.<br>

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Shared Voicemail","description":"Manage your shared voicemail.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/shared_voicemails/{id}/greetings/{greeting_id}/disable":{"post":{"tags":["Shared Voicemail"],"operationId":"disableSharedVoicemailGreeting","summary":"Disable shared voicemail greeting","description":"Disable shared voicemail greeting by it's unique ID.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of shared voicemail.\n"}},{"name":"greeting_id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of greeting.\n"}}],"responses":{"200":{"description":"OK"},"404":{"description":"User not found"}}}}}}
```

## Delete shared voicemail greeting

> Destroy a greeting from shared voicemail.<br>

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.0"},"tags":[{"name":"Shared Voicemail","description":"Manage your shared voicemail.\n"}],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/shared_voicemails/{id}/greetings/{greeting_id}/destroy":{"post":{"tags":["Shared Voicemail"],"operationId":"delSharedVoicemailGreeting","summary":"Delete shared voicemail greeting","description":"Destroy a greeting from shared voicemail.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of shared voicemail.\n"}},{"name":"greeting_id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"description":"The unique ID of greeting.\n"}}],"responses":{"204":{"description":"No Content"},"4XX":{"description":"Error"}}}}}}
```