---
title: "Create a shared voicemail"
method: POST
path: "/shared_voicemails"
tags: ["Shared Voicemail"]
---

# Create a shared voicemail

`POST /shared_voicemails`

## Request

- Base URL: `https://HOSTNAME:8887/api`
- URL: `https://HOSTNAME:8887/api/shared_voicemails`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/docs/shared_voicemails/post.ts> (a function with typed inputs; its response is checked against the schema)

Add a new shared voicemail.

## Request body

- object
  - `name` string, required: The name of shared voicemail.
  - `extension_number` string, required: The extension number.
  - `prompt` string: BCP 47 Language Tags (The Internet Best Current Practices (BCP) for language tags). A language tag is composed of a sequence of one or more subtags such as language, region, variant and script subtags. When a language tag is comprised of more than one subtag, the subtag values are separated by the "-" character. You will most commonly find language tags written with 2 subtags - language and region. For example: en-US.
  - `enable_pin` boolean: Whether the PIN is required to access shared voicemail.
  - `pin` string, required: The PIN number for accessing. The PIN policies include: 1. A sequence of numbers 6-10 digits in length. 2. No repeating numbers (e.g. "111", "222") 3. No sequential numbers (e.g. "012", "789")
  - `enable_email_notify` boolean: Enable email notify or not.
  - `recipients` string: Comma-separated list of email address that should receive notifications. Allow up to 15 email addresses.
  - `play_datetime` 'DISABLE' | '12_HOUR_CLOCK' | '24_HOUR_CLOCK': Announces Date and Time of Message. - `DISABLE`: Do not read; - `12_HOUR_CLOCK`: Read in 12-hour clock; - `24_HOUR_CLOCK`: Read in 24-hour clock.

## Response `201`

Created

- object
  - `id` string: The unique ID of the resource.

## Other responses

- `4XX`: Error

---

[API](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api.md) - [All operations](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/revisions/577415d4a3d5?raw)