Create voicemail

Create voicemail settings for a phone number. You can also configure a custom greeting by setting the greeting object: use mode custom_greeting together with a media_name that points to an audio file uploaded through the Media Storage API, or mode default to use the standard system greeting.

POST /phone_numbers/{phone_number_id}/voicemail

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const voicemail = await client.phoneNumbers.voicemail.create('123455678900');

console.log(voicemail.data);

200

{
  "data": {
    "enabled": true,
    "pin": "1234",
    "greeting": {
      "mode": "custom_greeting",
      "media_name": "my_voicemail_greeting"
    }
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

phone_number_id · string · required

The ID of the phone number.

Body

application/json

Details to create

pin · string

The pin used for voicemail

Example:

"1234"

enabled · boolean

Whether voicemail is enabled.

Example:

true

greeting · object

Controls the greeting a caller hears before leaving a voicemail. Set mode to default to play the standard system greeting, or to custom_greeting to play your own audio. When mode is custom_greeting, media_name is required and must reference an audio file already uploaded to your account through the Media Storage API.

Show child attributes

Response

200

application/json

Successful response

data · object

Show child attributes

Example:

{
  "enabled": true,
  "pin": "1234",
  "greeting": {
    "mode": "custom_greeting",
    "media_name": "my_voicemail_greeting"
  }
}