COcommpeak
Voicemail-Playbacks

Upload a voicemail playback

Creates a voicemail playback from an uploaded WAV file (multipart voicemail_playback[playback]). did_numbers (E.164) and did_number_tags (tag ids) assign the playback; both must belong to the account. send_to lists the email addresses recorded voicemails are sent to. Returns 422 with errors when the playback is rejected.

post/voicemail_playbacks

Request

  • Base URL
    https://api.commpeak.com/portal
  • URL
    https://api.commpeak.com/portal/voicemail_playbacks
  • Auth
    API key in header Authorization

Request body multipart/form-data

voicemail_playback[name]string

Playback name (required on create).

voicemail_playback[playback]string binary

WAV file (required on create; replaces the current file on update).

voicemail_playback[send_to][]string[]

Email addresses recorded voicemails are sent to.

voicemail_playback[did_numbers][]string[]

DID numbers (E.164) the playback is assigned to.

voicemail_playback[did_number_tags][]integer[]

DID tag ids the playback is assigned to.

Response

Successful Response

Example response

{
  "voicemail_playback": {
    "default": true,
    "did_number_tags": [
      {
        "id": 5,
        "name": "demo"
      }
    ],
    "did_numbers": [
      "12125551234"
    ],
    "id": 3,
    "name": "demo",
    "send_to": [
      "test@example.com"
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.