All endpoints

Every endpoint in every API on one page, with the scope it needs. Each one links to its full entry in the reference.

Messaging API

Base URL https://api.phound.app/messaging/v1

Conversations

GET /conversations List conversations messages:read
POST /conversations Create a conversation explicitly messages:send
GET /conversations/{id} Retrieve a conversation messages:read
GET /conversations/{id}/messages Read a thread messages:read

Messages

POST /messages Send a message messages:send
GET /messages Search and list messages across all conversations messages:read
POST /messages/preview See what a send would do, without sending it messages:send
GET /messages/{id} Retrieve a message messages:read
POST /messages/{id}/cancel Cancel a scheduled message messages:send
POST /media Upload a file to send as MMS messages:send

Suppressions

GET /suppressions List suppressions suppressions:read
POST /suppressions Stop messaging an address suppressions:write
GET /suppressions/{id} Retrieve a suppression suppressions:read
DELETE /suppressions/{id} Remove a suppression suppressions:write

Account API

Base URL https://api.phound.app/accounts/v1

Account

GET /account Retrieve your account account:read
GET /introspect See what your credential may do any credential

Personas

GET /personas List your personas personas:read
GET /personas/{id} Retrieve one persona personas:read

Contacts

GET /contacts List and search contacts contacts:read
GET /contacts/{id} Retrieve a contact contacts:read

Numbers

GET /available-phone-numbers Search for numbers to buy numbers:read
GET /phone-numbers List your numbers and what each can do numbers:read
POST /phone-numbers Buy a number numbers:buy
GET /phone-numbers/{phone_number} Retrieve one number numbers:read
PATCH /phone-numbers/{phone_number} Assign or relabel a number numbers:write
DELETE /phone-numbers/{phone_number} Release a number numbers:buy
POST /phone-numbers/{phone_number}/restore Restore a released number numbers:buy

Registration

POST /10dlc-registration Submit your business's 10DLC registration account:write

API keys

GET /api-keys List your API keys keys:manage
POST /api-keys Create an API key keys:manage
PATCH /api-keys/{id} Update an API key keys:manage
DELETE /api-keys/{id} Revoke an API key keys:manage

Webhooks

GET /webhooks List subscriptions webhooks:manage
POST /webhooks Create a subscription webhooks:manage
GET /webhooks/{id} Retrieve a subscription webhooks:manage
PATCH /webhooks/{id} Update a subscription webhooks:manage
DELETE /webhooks/{id} Delete a subscription webhooks:manage
POST /webhooks/{id}/rotate-secret Rotate the signing secret with an overlap window webhooks:manage
POST /webhooks/{id}/test Send a test event and report exactly what happened webhooks:manage
GET /webhooks/{id}/deliveries The delivery log webhooks:manage
POST /webhook-deliveries/{id}/retry Replay one delivery webhooks:manage

Usage

GET /usage Usage summary usage:read
GET /api-requests The request log usage:read

Recordings API

Base URL https://api.phound.app/recordings/v1

Recordings

GET /recordings List your recordings recordings:read
GET /recordings/{id} Retrieve one recording recordings:read
PATCH /recordings/{id} Rename, describe, tag or password-protect a recording recordings:write
DELETE /recordings/{id} Move a recording to the bin recordings:write
POST /recordings/{id}/restore Restore a recording from the bin recordings:write
PUT /recordings/{id}/dropbox Move a recording to Dropbox recordings:write
DELETE /recordings/{id}/dropbox Bring a recording back from Dropbox recordings:write
GET /recording-tags List the tags you use recordings:read

Feed

GET /recordings-feed Retrieve your podcast feed recordings:read
PUT /recordings-feed Publish or change your podcast feed recordings:write
DELETE /recordings-feed Unpublish your podcast feed recordings:write

Storage

GET /storage-quota Retrieve your storage use recordings:read

Calls API

Base URL https://api.phound.app/calls/v1

Calls

GET /calls List your calls calls:read
GET /calls/{id} Retrieve one call calls:read

Flows

GET /flows List your flows call_settings:read
GET /flows/{id} Retrieve one flow call_settings:read
GET /personas/{persona_id}/flow See how a persona's calls are answered call_settings:read
PUT /personas/{persona_id}/flow Change how a persona's calls are answered call_settings:write

Voicemails

GET /voicemails List your voicemails voicemails:read
GET /voicemails/{id} Retrieve one voicemail voicemails:read

Voicemail settings

GET /personas/{persona_id}/voicemail See a persona's voicemail settings call_settings:read
PATCH /personas/{persona_id}/voicemail Change a persona's voicemail settings call_settings:write
PUT /personas/{persona_id}/voicemail/greeting Upload a persona's voicemail greeting call_settings:write

Media streams

GET /live-calls List your streamed calls calls:stream
POST /live-calls Call a phone number and stream the call calls:stream
GET /live-calls/{live_call_id} Retrieve a streamed call calls:stream
POST /live-calls/{live_call_id}/hangup Hang up a streamed call calls:stream