Storefronts
- Invoices
- Credit Notes
Customer Management
VoIP Bundle (Subscriptions)
- VoIP Subscription Bundle
SIP Account Management
Audio Management
- Sounds
- Playlists
Phone Numbers & Call Routing
Phone Calls & CDR Data
VoIP Phone Short Code
- Short Codes
eFax Management
- Fax Messages
- Fax Authorized Senders
Voicemails & Mailboxes
Caller ID
- Caller IDs
- Caller ID Requests
SIP Trunks
- Trunk Authentication
- VoIP Trunks
Wallboard Statistics
VoIP Phone Provisioning
- Devices
Call Queueing
Phone Books
- Phone Book
- Phone Book Contact
VoIP Phone Speed Dial
- Speed Dials
Text (SMS) Messaging
- Text Message Campaign

API Access

Build custom apps using our JSON API

Configure API

Fax Authorized Senders

Commands to manage who is allowed to send faxes via the fax to email system

Become a Reseller

Filter:

All
GET
POST
PUT
DELETE
Chargeable *

* You will be charged every time this command is run.

GET/voip/fax/sender

Gets a list of all the currently authorized fax senders on the account

Request Details

Response Details

Request Details

This command has no URL/Query String parameters

Response Details

200 Response

{
    "result" : [
        {
            "caller_id" : "09c1b1a7-b5d5-457f-a0aa-dc78d0205760",
            "created_on" : "2023-06-07",
            "email" : "help@yay.com",
            "updated_on" : "2023-06-07",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
        }
    ],
    "status_code" : 200,
    "status_message" : "OK"
}

GET/voip/fax/sender/{uuid}

Gets a specific fax sender on the account

Request Details

Response Details

Request Details

URL and Query String Parameters

Name
Type
Required

- uuid
- String
- True
The UUID of the Fax Sender to be queried

Response Details

200 Response

{
    "result" : {
        "caller_id" : "09c1b1a7-b5d5-457f-a0aa-dc78d0205760",
        "created_on" : "2023-06-07",
        "email" : "help@yay.com",
        "updated_on" : "2023-06-07",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "status_code" : 200,
    "status_message" : "OK"
}

404 Response

{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}

POST/voip/fax/sender

Creates a new authorized fax sender

Request Details

Response Details

Request Details

This command has no URL/Query String parameters

POST body

Name
Type
Required

- caller_id
- String
- True
The UUID of the caller_id used when this sender sends a fax
- email
- String
- True
The email address authorized to send faxes from this account

JSON all-fields example:

{
    "caller_id" : "09c1b1a7-b5d5-457f-a0aa-dc78d0205760",
    "email" : "help@yay.com"
}

Response Details

201 Response

{
    "result" : {
        "caller_id" : "09c1b1a7-b5d5-457f-a0aa-dc78d0205760",
        "created_on" : "2023-06-07",
        "email" : "help@yay.com",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "status_code" : 201,
    "status_message" : "Created"
}

400 Response

{
    "result" : {},
    "status_code" : 400,
    "status_message" : "Bad Request"
}

PUT/voip/fax/sender/{uuid}

Updates the specified authorized fax sender

Request Details

Response Details

Request Details

URL and Query String Parameters

Name
Type
Required

- uuid
- String
- True
The UUID of the Fax Sender to be updated

PUT body

Name
Type
Required

- caller_id
- String
- True
The UUID of the caller_id used when this sender sends a fax
- email
- String
- True
The email address authorized to send faxes from this account

JSON all-fields example:

{
    "caller_id" : "09c1b1a7-b5d5-457f-a0aa-dc78d0205760",
    "email" : "help@yay.com"
}

Response Details

200 Response

{
    "result" : {
        "caller_id" : "09c1b1a7-b5d5-457f-a0aa-dc78d0205760",
        "created_on" : "2023-06-07",
        "email" : "help@yay.com",
        "updated_on" : "2023-06-07",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "status_code" : 200,
    "status_message" : "OK"
}

400 Response

{
    "result" : {},
    "status_code" : 400,
    "status_message" : "Bad Request"
}

404 Response

{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}

409 Response

{
    "result" : {},
    "status_code" : 409,
    "status_message" : "Conflict"
}

DELETE/voip/fax/sender/{uuid}

Deletes the specified fax sender
Back to top

Request Details

Response Details
Request Details

URL and Query String Parameters
- Name
- Type
- Required
- uuid
  
  String
  
  True
  
  The UUID of the Fax Sender to be deleted
Response Details

204 Response
```
{
    "result" : {},
    "status_code" : 204,
    "status_message" : "No Content"
}
```
404 Response
```
{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}
```