COcollectwise

Drop a voicemail

Changed on

Sends an automated voicemail to the specified phone number

post/dropVoicemail

Request

  • Base URL
    https://collectwiseapi.com
  • URL
    https://collectwiseapi.com/dropVoicemail
  • Auth
    API key in header collectwise_key

Headers

x-cw-timestampstring

Required together with x-cw-signature when signing is enabled for this key or organization. POST /security/verify also requires signing whenever a usable secret exists. Canonical Unix seconds, within ±300 seconds. See API Access for CW1 signing.

x-cw-signaturestring

CW1 HMAC-SHA256 signature: v1= followed by 64 lowercase hex digits. Use the decoded 32-byte signing secret and exact request bytes. See API Access.

Request body

phoneNumberstring required

Phone number in E.164 format (e.g., +18768828822)

messagestring required

The voicemail message to be delivered

callbackNumberstring required

Callback phone number in E.164 format

voiceGender'male' | 'female'

Gender of the voice to use for the voicemail

Response

Voicemail sent successfully

messagestring

Example response

{
  "message": "Voicemail delivered successfully"
}

Changes

  • 95fad0d2f369Revision changes
    • info

      added the new optional header request parameter x-cw-signature

    • info

      added the new optional header request parameter x-cw-timestamp

    • info

      added the non-success response with the status