Pamfax
You can use the PamFax API to send faxes, show incoming faxes, create new PamFax users, and a lot more.
70 subscribers
51 endpoints
The in-depth APIMemo review for this API hasn't been published yet —
the data below comes straight from the public marketplace listing.
Pamfax endpoints
| Method | Endpoint | Description |
|---|---|---|
| FaxJob | ||
| GET |
RemoveAllRecipients /FaxJob/RemoveAllRecipients |
Removes all recipients for the current fax. |
| GET |
GetPreview /FaxJob/GetPreview |
Returns the states of all preview pages. Call after fax is ready (GetFaxState returns FAX_READY_TO_SEND). |
| GET |
SetNotifications /FaxJob/SetNotifications |
Sets the notification options for the current fax. Notification options that are not in the array will not be changed/resetted. Note: defaults for notification settings will be… |
| GET |
RemoveAllFiles /FaxJob/RemoveAllFiles |
Remove all uploaded files from the current fax |
| GET |
AddRemoteFile /FaxJob/AddRemoteFile |
Add a remote file to the fax. The url parameter may contain username:password for basic http auth, but this is the only supported authentication method. URL Examples:… |
| GET |
ListFaxFiles /FaxJob/ListFaxFiles |
Get all uploaded files for the current fax |
| GET |
Create /FaxJob/Create |
Creates a new fax in the API backend and returns it. If a fax job is currently in edit mode in this session, this fax job is returned instead. Note: This is not an error. It… |
| GET |
GetFaxState /FaxJob/GetFaxState |
Returns the state of the current fax. |
| GET |
ListRecipients /FaxJob/ListRecipients |
Returns the recipients for the current fax. |
| GET |
SetRecipients /FaxJob/SetRecipients |
Creates recipients for the current fax. All recipients are replaced with the given ones! Note that each name may be 80 characters long. More characters will be cut off. |
| GET |
SendLater /FaxJob/SendLater |
Put the fax in the unpaid faxes queue. Only possible if user has NOT enough credit to send this fax directly. You may pass in a datetime when the fax shall be sent. This must be… |
| GET |
ResetNotifications /FaxJob/ResetNotifications |
Resets the notification options for the current fax to their default values. Notification options will be set to what is set for the user as default. |
| GET |
Send /FaxJob/Send |
Start the fax sending. Only successfull if all necessary data is set to the fax: at least 1 recipient and a cover page or a file uploaded. Will only work if user has enough… |
| GET |
ListAvailableCovers /FaxJob/ListAvailableCovers |
Returns a list of all coverpages the user may use. Result includes the "no cover" if the fax job already contains a file as in that case there's no need to add a cover. |
| GET |
RemoveCover /FaxJob/RemoveCover |
Removes the cover from fax |
| GET |
StartPreviewCreation /FaxJob/StartPreviewCreation |
Starts creating the preview for this fax. Call after fax is ready (GetFaxState returns FAX_READY_TO_SEND) DEPRECATED! Use FaxJob::GetPreview instead |
| GET |
SetCover /FaxJob/SetCover |
Sets the cover template for the current fax. IMPORTANT NOTE: This method allowed only selection of cover template using the cover_id argument up to and including API 3.4MR8. We… |
| Shopping | ||
| GET |
ListAvailableItems /Shopping/ListAvailableItems |
Returns a list of available items from the shop. When a user is logged in, it will also contain the items only available to validated customers. |
| GET |
RedeemCreditVoucher /Shopping/RedeemCreditVoucher |
Redeem a credit voucher. These are different then the shop vouchers to be used in the online shop! You can use "PCPC0815" to test this function in the Sandbox API |
| GET |
GetShopLink /Shopping/GetShopLink |
Returns different shop links. Use these links to open a browser window with the shop in a specific state. |
| GET |
AddCreditToSandboxUser /Shopping/AddCreditToSandboxUser |
Adds some credit in user's currency to the currently logged in user. NOTES: This method is for testing purposes only, so it is not available in the LIVE system. Use it to create… |
| NumberInfo | ||
| GET |
GetNumberInfo /NumberInfo/GetNumberInfo |
Get some information about a fax number. Result contains zone, type, city, ... Validates and corrects the number too. |
| GET |
GetPagePrice /NumberInfo/GetPagePrice |
Calculate the expected price per page to a given fax number. Use GetNumberInfo when you do not need pricing information, as calculating expected price takes longer then just… |
| OnlineStorage | ||
| GET |
ListProviders /OnlineStorage/ListProviders |
Returns a list of supported providers. |
| FaxHistory | ||
| GET |
ListTrash /FaxHistory/ListTrash |
Lists all faxes in trash. |
| GET |
ListSentFaxes /FaxHistory/ListSentFaxes |
List all sent faxes (successful or not) |
| GET |
ListInboxFaxes /FaxHistory/ListInboxFaxes |
List all faxes in the inbox of the current user. |
| GET |
ListOutboxFaxes /FaxHistory/ListOutboxFaxes |
Faxes in the outbox that are currently in the sending process |
| GET |
CountFaxes /FaxHistory/CountFaxes |
Returns the number of faxes from users history with a specific state. |
| GET |
EmptyTrash /FaxHistory/EmptyTrash |
Removes all faxes from trash for user and if user is member of a company and has delete rights also for the owners inbox faxes |
| GET |
ListUnpaidFaxes /FaxHistory/ListUnpaidFaxes |
Lists all unpaid faxes That are waiting for a payment. When this user makes a transaction to add credit, these faxes will be sent automatically if they are younger that 2 hours. |
| GET |
ListRecentFaxes /FaxHistory/ListRecentFaxes |
Returns a list of latest faxes for the user. Does not contain deleted and delayed faxes (See ListTrash for deleted faxes). |
| GET |
ListRecentRecipients /FaxHistory/ListRecentRecipients |
Returns a list of the last recipient This is fixed to a maximum of 20 records. |
| Session | ||
| GET |
ListChanges /Session/ListChanges |
Returns all changes in the system that affect the currently logged in user. This could be changes to the user's profile, credit, settings, ... Changes will be deleted after you… |
| GET |
Logout /Session/Logout |
Terminate the current session. |
| GET |
CreateLoginIdentifier /Session/CreateLoginIdentifier |
Creates an identifier for the current user The created identifier then can be passed to the portal to directly log in the user: https://portal.pamfax.biz/?_id= Be aware that… |
| GET |
RegisterListener /Session/RegisterListener |
Registers listeners for the current session. Any change of the listened types will then be available via Session::ListChanges function |
| GET |
ReloadUser /Session/ReloadUser |
Returns the current user object. Use this if you need to ensure that your locally stored user object is up to date. |
| GET |
VerifyUser /Session/VerifyUser |
Verifies a PamFax user via username/password |
| Common | ||
| GET |
ListVersions /Common/ListVersions |
Lists the current Versions. Result contains versions for the PamFax Gadget, Client etc and returns the version and update url |
| GET |
ListCountriesForZone /Common/ListCountriesForZone |
Returns all countries in the given zone Result includes their translated names, countrycode and country-prefix. |
| GET |
ListLanguages /Common/ListLanguages |
List all available languages. Result may be filtered to that only languages are returned that are at least translated $min_percent_translated % |
| GET |
ListCountries /Common/ListCountries |
Returns a preview page for a fax. May be in progress, sent or from inbox. |
| GET |
ListCurrencies /Common/ListCurrencies |
Returns the list of supported currencies. Result contains convertion rates too. If $code is given will only return the specified currency's information. |
| GET |
ListSupportedFileTypes /Common/ListSupportedFileTypes |
Returns the supported file types for documents that can be faxed. |
| GET |
ListTimezones /Common/ListTimezones |
List all supported timezones. TimezonesList result list will contain attributes 'default' and (if a user is logged in) 'user_timezone' which contain that values. Additionally the… |
| GET |
GetCurrentCultureInfo /Common/GetCurrentCultureInfo |
Returns the current culture info data. |
| GET |
ListZones /Common/ListZones |
Returns price and price_pro for a given zone |
| GET |
GetCurrentSettings /Common/GetCurrentSettings |
Returns the current settings for timezone and currency. This is the format/timezone ALL return values of the API are in. These are taken from the user (if logged in, the api… |
| GET |
GetGeoIPInformation /Common/GetGeoIPInformation |
Returns Geo information based on the given IP address (IPV4) |
+ 1 more endpoints on the provider's documentation.
Pamfax pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — |
|
