POST /api/v2/fax
Sends a fax to a phone number.
Added on Nov 27, 2023 for API v2.
Rate limit: 250 per minute.
Servers
- https://dialpad.com/
- https://sandbox.dialpad.com/
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
infer_country_code |
Boolean | No |
If true, to_number will be assumed to be from the sender's country, and the E164 format requirement will be relaxed. Default value: false |
from_number |
String | No |
The E164-formatted phone number of the sender. The number must be assigned to a user or a group. If a group is assigned to the from_number, user_id must be specified. |
user_id |
Integer | No |
The ID of the user who should be the sender of the SMS. |
to_number |
String | Yes |
The E164-formatted phone number of the recipient. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.