Reference · Partner API (PAPI) — Telavox Developer Portal

Stable

JavaScript-disabled view. The interactive reference renders client-side. This is a static endpoint catalog; the full OpenAPI document is at /api/spec/papi?v=v1.

Access Tags

DELETE /v1/accesstag/{accesstag} — Delete access tag
GET /v1/accesstag — List access tags
POST /v1/accesstag — Create access tag

Admin Portal

GET /v1/customers/{customer}/admin-portal — Log in to Admin Portal as customer
GET /v1/customers/{customer}/admin-portal-raw — Get Admin Portal login URL for customer
GET /v1/customers/{customer}/admin-portal/{user} — Log in to Admin Portal as user
GET /v1/customers/{customer}/admin-portal-raw/{user} — Get Admin Portal login URL for user

CAPI API Users

GET /v1/customers/{customer}/api-users — List API users
POST /v1/customers/{customer}/api-users — Create API user
DELETE /v1/customers/{customer}/api-users/{api-user} — Delete API user
GET /v1/customers/{customer}/api-users/{api-user}/tokens — List API user tokens
POST /v1/customers/{customer}/api-users/{api-user}/tokens — Create CAPI bearer token
PUT /v1/customers/{customer}/api-users/{api-user}/tokens/{capi-token} — Schedule token invalidation
DELETE /v1/customers/{customer}/api-users/{api-user}/tokens/{capi-token} — Invalidate token immediately

Assortments

GET /v1/customers/{customer}/assortment/{country} — List assortments by currency for a country
GET /v1/customers/{customer}/assortment/{country}/{currency} — Get assortment for country and currency
GET /v1/customers/{customer}/assortment — List assortments by country and currency
GET /v1/customers/{customer}/assortment/{country}/{currency}/pbx-licenses — List purchasable PBX licenses
GET /v1/customers/{customer}/assortment/{country}/{currency}/user-licenses — List purchasable user licenses

Branding

DELETE /v1/customers/{customer}/branding-usage — Remove branding usage for customer
POST /v1/customers/{customer}/branding-usage/{branding} — Set branding usage for customer
GET /v1/brandings — Get brandings for retailer
GET /v1/brandings/{brandingKey}/logos — Get branding logos by key
GET /v1/brandings/{brandingKey}/logos/{logo} — Get the bytes for the file
GET /v1/brandings/{brandingKey} — Get branding info by key

Call Routing

DELETE /v1/customers/{customer}/extensions/users/{user}/call-routings/{callRouting} — Deletes the call routing on a subscriber
GET /v1/customers/{customer}/extensions/users/{user}/call-routings — Lists all the call routings on a subscriber
POST /v1/customers/{customer}/extensions/users/{user}/call-routings — Adds the provided call routings to the subscriber

Customer Metadata

GET /v1/customers/metadata/extensions — List extension metadata
GET /v1/customers/metadata/terminals — List terminal metadata
GET /v1/customers/metadata/phonenumbers — List phone number metadata

Customers

GET /v1/customers/{customer} — Get customer
PUT /v1/customers/{customer} — Update customer state
DELETE /v1/customers/{customer} — Cancel customer
GET /v1/customers/active/details — List active customers with details
GET /v1/customers/details — List specific customers with details
GET /v1/customers/all/details — List all customers with details
GET /v1/customers/suspended — List suspended customers
PUT /v1/customers/details/{customer} — Update customer details
POST /v1/customers/{country}/{currency} — Create customer
GET /v1/customers — List active customers

Extensions

GET /v1/customers/{customer}/extensions — Available extension resources in this api.
GET /v1/customers/{customer}/extensions/users — List all users on the customer
GET /v1/customers/{customer}/extensions/users/{user} — Get information about one user on the customer

Invoice Addresses

PUT /v1/invoiceaddresses/by-ocr/{ocr} — Update a customer's invoice address by OCR

Invoice Places

GET /v1/customers/{customer}/invoice-places/{country} — Available invoice places in the supplied country.
GET /v1/customers/{customer}/invoice-places — Available invoice places for the customer.
GET /v1/customers/{customer}/invoice-places/{country}/{currency} — Available invoice places in the supplied country, with the supplied currency.
POST /v1/customers/{customer}/invoice-places/{country}/{currency} — Create a new invoice place
PUT /v1/customers/{customer}/invoice-places/{invoicePlace} — Update an invoice place
DELETE /v1/customers/{customer}/invoice-places/{invoicePlace} — Delete an invoice place

Invoices

GET /v1/invoices/by-ocr/{ocr} — Read invoice details by OCR
POST /v1/invoices/by-ocr/{ocr}/resend — Resend an invoice to the customer's invoice email

Log Events

GET /v1/customers/{customer}/log-events/categories — Get log event categories
GET /v1/customers/{customer}/log-events/{log-event} — Get information regarding a log event
GET /v1/customers/{customer}/log-events — Get log events

Orders

GET /v1/customers/{customer}/orders/content/{order-key} — List order content for an order
GET /v1/customers/{customer}/orders/{order-key} — Get order details including content
GET /v1/customers/{customer}/orders — List orders

Partner Users

GET /v1/partnerusers — List active partner users
POST /v1/partnerusers — Create partner user
GET /v1/partnerusers/{partneruser} — Get partner user
DELETE /v1/partnerusers/{partneruser} — Remove partner user
POST /v1/partnerusers/{partneruser}/accesstags — Add access tag to partner user
DELETE /v1/partnerusers/{partneruser}/accesstags/{partneruseraccesstag} — Remove access tag from partner user

Products

GET /v1/customers/{customer}/products/pbx-licenses/{country}/{currency} — Get active PBX license
GET /v1/customers/{customer}/products/pbx-licenses/{country} — List PBX license currencies for country
GET /v1/customers/{customer}/products/pbx-licenses — List PBX license country and currency
POST /v1/customers/{customer}/products/pbx-licenses/{country}/{currency}/{assortment-item} — Purchase PBX license
GET /v1/customers/{customer}/products/user-licenses/{country}/{currency}/assigned — List all owned licenses that are currently assigned to a user
GET /v1/customers/{customer}/products/user-licenses/{country}/{currency} — List all licenses belonging to the customer
GET /v1/customers/{customer}/products/user-licenses/{country} — List all currencies that the customer has available licenses for
GET /v1/customers/{customer}/products/user-licenses — List all countries and currencies that the customer has available licenses for
DELETE /v1/customers/{customer}/products/user-licenses — Cancel unused licenses belonging to the customer
POST /v1/customers/{customer}/products/user-licenses/{country}/{currency}/{assortment-item} — Purchase a user license
GET /v1/customers/{customer}/products/user-licenses/{country}/{currency}/unassigned — List all licenses that are currently not assigned to a user
DELETE /v1/customers/{customer}/products/user-licenses/{product} — Cancel an unused license belonging to the customer

Phone Numbers

GET /v1/customers/{customer}/phone-numbers — List customer phone numbers
PUT /v1/customers/{customer}/phone-numbers/{anumber}/swap — Swap phone numbers
GET /v1/phone-numbers/{country} — List available phone numbers
POST /v1/phone-numbers — Add numbers to pool
PUT /v1/phone-numbers/{number-key} — Update phone number
DELETE /v1/phone-numbers/{anumber} — Remove phone number from pool

Places

GET /v1/customers/{customer}/places — List available places for the customer.
DELETE /v1/customers/{customer}/places/{place} — Delete a place which has no invoicePlaces connected to it.

Price Lists

GET /v1/pricelists — List price lists

Roles

GET /v1/partnerusers/roles — List available roles
POST /v1/partnerusers/{partneruser}/roles — Add roles to partner user
DELETE /v1/partnerusers/{partneruser}/roles/{role} — Remove role from partner user

Search

GET /v1/search — Search phone numbers

Loading interactive reference…