Skip to content
Console
Menu

Getting Started

Authentication

KV Store

Read voicemail on a phone number

ReadPhoneNumberVoicemail: existing provider-managed lines; execution credentials are transient.

ReadPhoneNumberVoicemail: existing provider-managed lines; execution credentials are transient.

  • Path POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/phone_numbers/phone-number:readVoicemail
  • Scope notify:read
  • Effect read — nothing is written.
  • Collection phone_numbers

#Request

FieldTypeWhat it is
namestringConnected line. Required.
provider_call_idstringStable provider receipt id already held by this line. Required.
start_daystringDay window to re-establish receipt ownership. Required.
end_daystringLast day inclusive, at most one day after start_day. Required.
provider_session_tokenstringTransient provider session. Required. Never returned again.

#Response

FieldTypeWhat it is
audiobytesExact provider recording bytes, maximum 2 MiB. Never returned again.
audio_sha256stringSHA-256 of those bytes.

#Errors

Every error arrives in the body Errors describes.

#Examples

curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/phone_numbers/phone-number:readVoicemail" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"end_day":"…","provider_call_id":"…","provider_session_token":"…","start_day":"…"}'