Get a voicemail for a call

Retrieve a voicemail associated with a specific call. Returns null data fields while the voicemail is processing in our system. Returns competed data fields when the voicemail has finished processing.

GET /v1/call-voicemails/{callId}

Get a voicemail for a call

cURL

curl --request GET \
  --url https://dev-public-api.openphone.dev/v1/call-voicemails/{callId} \
  --header 'Authorization: <api-key>'

200

{
  "data": {
    "duration": 60,
    "id": "VMaaff8f317e0c4e61953b74a5eb42a370",
    "transcript": "Hello, this is a voicemail from John Doe.",
    "recordingUrl": "https://examplestorage.com/a643d4d3e1484fcc8b721627284eda5e.mp3",
    "status": "completed"
  }
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Path Parameters

callId · string · required

The unique identifier of the call for which a voicemail is being retrieved.

Pattern: ^AC(.*)$

Example:

"AC3700e624eca547eb9f749a06f"

Response

200

application/json

OK

data · object · required

Show child attributes