const axios = require('axios');
const OutboxApiFp = require('@alohi/faxplus-api').OutboxApiFp;
const Configuration = require('@alohi/faxplus-api').Configuration;
const config = new Configuration({
accessToken: accessToken,
basePath: 'https://restapi.fax.plus/v3',
// Header required only when using the OAuth2 token scheme
baseOptions: {
headers: {
"x-fax-clientid": clientId,
}
}
});
async function bulkUpdateOutboxFaxes() {
const reqParams = {
"userId": "self",
"bulkOutboxUpdateRequest": {
"ids": [
"a1b2c3d4e5f6789012345678901234ab",
"b2c3d4e5f6789012345678901234abc"
],
"comment": "updated via bulk"
}
};
const req = await OutboxApiFp(config).bulkUpdateOutboxFaxes(reqParams);
const resp = await req(axios);
}
bulkUpdateOutboxFaxes();
from faxplus import ApiClient, OutboxApi, BulkOutboxUpdateRequest
from faxplus.configuration import Configuration
conf = Configuration()
conf.access_token = access_token
# header_name and header_value required only when using the OAuth2 token scheme
api_client = ApiClient(header_name='x-fax-clientid', header_value=client_id, configuration=conf)
api = OutboxApi(api_client)
payload = BulkOutboxUpdateRequest(
ids=[
"a1b2c3d4e5f6789012345678901234ab",
"b2c3d4e5f6789012345678901234abc",
],
comment="updated via bulk",
)
resp = api.bulk_update_outbox_faxes(user_id="self", body=payload)
# You can also use wget
curl -X PUT "https://restapi.fax.plus/v3/accounts/self/outbox" \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
# The x-fax-clientid header is required only when using the OAuth2 token scheme
-H 'x-fax-clientid: YOUR_CLIENT_ID' \
-d '{
"ids": [
"a1b2c3d4e5f6789012345678901234ab",
"b2c3d4e5f6789012345678901234abc"
],
"comment": "updated via bulk"
}'
{
"results": [
{
"id": "<string>",
"code": 204
}
]
}{
"error": "invalid_user_id",
"description": "Invalid user id given"
}{
"error": "unauthorized",
"description": "The access token provided is expired, revoked, malformed, or invalid for other reasons."
}{
"error": "internal_server_error",
"description": "An unexpected error happened, please contact support"
}Outbox
Bulk update outbox faxes
Bulk update multiple outbox fax records (update comment). Maximum 100 outbox fax IDs per request. Duplicate IDs are automatically ignored. Jobs in ‘sending’ status cannot be updated and will return a 409 status code. (Permitted scopes: fax:all:edit, fax:fax:edit)
PUT
/
accounts
/
{user_id}
/
outbox
const axios = require('axios');
const OutboxApiFp = require('@alohi/faxplus-api').OutboxApiFp;
const Configuration = require('@alohi/faxplus-api').Configuration;
const config = new Configuration({
accessToken: accessToken,
basePath: 'https://restapi.fax.plus/v3',
// Header required only when using the OAuth2 token scheme
baseOptions: {
headers: {
"x-fax-clientid": clientId,
}
}
});
async function bulkUpdateOutboxFaxes() {
const reqParams = {
"userId": "self",
"bulkOutboxUpdateRequest": {
"ids": [
"a1b2c3d4e5f6789012345678901234ab",
"b2c3d4e5f6789012345678901234abc"
],
"comment": "updated via bulk"
}
};
const req = await OutboxApiFp(config).bulkUpdateOutboxFaxes(reqParams);
const resp = await req(axios);
}
bulkUpdateOutboxFaxes();
from faxplus import ApiClient, OutboxApi, BulkOutboxUpdateRequest
from faxplus.configuration import Configuration
conf = Configuration()
conf.access_token = access_token
# header_name and header_value required only when using the OAuth2 token scheme
api_client = ApiClient(header_name='x-fax-clientid', header_value=client_id, configuration=conf)
api = OutboxApi(api_client)
payload = BulkOutboxUpdateRequest(
ids=[
"a1b2c3d4e5f6789012345678901234ab",
"b2c3d4e5f6789012345678901234abc",
],
comment="updated via bulk",
)
resp = api.bulk_update_outbox_faxes(user_id="self", body=payload)
# You can also use wget
curl -X PUT "https://restapi.fax.plus/v3/accounts/self/outbox" \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
# The x-fax-clientid header is required only when using the OAuth2 token scheme
-H 'x-fax-clientid: YOUR_CLIENT_ID' \
-d '{
"ids": [
"a1b2c3d4e5f6789012345678901234ab",
"b2c3d4e5f6789012345678901234abc"
],
"comment": "updated via bulk"
}'
{
"results": [
{
"id": "<string>",
"code": 204
}
]
}{
"error": "invalid_user_id",
"description": "Invalid user id given"
}{
"error": "unauthorized",
"description": "The access token provided is expired, revoked, malformed, or invalid for other reasons."
}{
"error": "internal_server_error",
"description": "An unexpected error happened, please contact support"
}const axios = require('axios');
const OutboxApiFp = require('@alohi/faxplus-api').OutboxApiFp;
const Configuration = require('@alohi/faxplus-api').Configuration;
const config = new Configuration({
accessToken: accessToken,
basePath: 'https://restapi.fax.plus/v3',
// Header required only when using the OAuth2 token scheme
baseOptions: {
headers: {
"x-fax-clientid": clientId,
}
}
});
async function bulkUpdateOutboxFaxes() {
const reqParams = {
"userId": "self",
"bulkOutboxUpdateRequest": {
"ids": [
"a1b2c3d4e5f6789012345678901234ab",
"b2c3d4e5f6789012345678901234abc"
],
"comment": "updated via bulk"
}
};
const req = await OutboxApiFp(config).bulkUpdateOutboxFaxes(reqParams);
const resp = await req(axios);
}
bulkUpdateOutboxFaxes();
from faxplus import ApiClient, OutboxApi, BulkOutboxUpdateRequest
from faxplus.configuration import Configuration
conf = Configuration()
conf.access_token = access_token
# header_name and header_value required only when using the OAuth2 token scheme
api_client = ApiClient(header_name='x-fax-clientid', header_value=client_id, configuration=conf)
api = OutboxApi(api_client)
payload = BulkOutboxUpdateRequest(
ids=[
"a1b2c3d4e5f6789012345678901234ab",
"b2c3d4e5f6789012345678901234abc",
],
comment="updated via bulk",
)
resp = api.bulk_update_outbox_faxes(user_id="self", body=payload)
# You can also use wget
curl -X PUT "https://restapi.fax.plus/v3/accounts/self/outbox" \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
# The x-fax-clientid header is required only when using the OAuth2 token scheme
-H 'x-fax-clientid: YOUR_CLIENT_ID' \
-d '{
"ids": [
"a1b2c3d4e5f6789012345678901234ab",
"b2c3d4e5f6789012345678901234abc"
],
"comment": "updated via bulk"
}'
Authorizations
oauth2personal_access_token
OAuth2 Authorization Grant
FlowAuthorization Code
- Authorization URL
- https://accounts.fax.plus/login?response_type=code&client_id=YOUR_CLIENT_ID&redirect_uri=http://localhost&scope=all
- Token URL
- https://accounts.fax.plus/token
- Refresh URL
- https://accounts.fax.plus/token?grant_type=refresh_token&refresh_token=YOUR_REFRESH_TOKEN
Scopes1
all
for now when a user grants permission, all grants will be permitted
Path Parameters
User ID. Use 'self' for your own account, or provide a specific user ID for corporate member accounts.
Body
application/json
Request to bulk update multiple outbox fax records
Request to bulk update multiple outbox fax records
Response
Response containing bulk operation results for outbox faxes
Bulk operation result for outbox faxes
Per-item results for each outbox fax ID
Show child attributes
Show child attributes