Skip to main content

FaxService

A list of all methods in the FaxService service. Click on the method name to view detailed information about that method.

MethodsDescription
create_fax_messageCreates and sends/re-sends a fax message. Re-send can be implemented if sending has failed. Fax attachment size (both single and total) is limited to 50Mb.
list_fax_cover_pagesReturns fax cover pages available for the current extension.

create_fax_message

Creates and sends/re-sends a fax message. Re-send can be implemented if sending has failed. Fax attachment size (both single and total) is limited to 50Mb.

  • HTTP Method: POST
  • Endpoint: /restapi/v1.0/account/{accountId}/extension/{extensionId}/fax

Parameters

NameTypeRequiredDescription
request_bodydictThe request body.
account_idstrInternal identifier of the RingCentral account (can be set to "~" to indicate that the account associated with current authorization session should be used)
extension_idstrInternal identifier of the RingCentral extension/user (can be set to "~" to indicate that the extension associated with current authorization session should be used)

Return Type

FaxResponse

Example Usage Code Snippet

from ring_central import RingCentral, Environment
from ring_central.models import CreateFaxMessageRequest

sdk = RingCentral(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value
)

request_body = {
"attachment": "attachment",
"fax_resolution": "High",
"to": [
{
"phone_number": "+18661234567",
"name": "name"
}
],
"send_time": "sendTime",
"iso_code": "US",
"cover_index": 3,
"cover_page_text": "uttemp"
}

result = sdk.fax.create_fax_message(
request_body=request_body,
account_id="~",
extension_id="~"
)

print(result)

list_fax_cover_pages

Returns fax cover pages available for the current extension.

  • HTTP Method: GET
  • Endpoint: /restapi/v1.0/dictionary/fax-cover-page

Parameters

NameTypeRequiredDescription
pageintIndicates a page number to retrieve. Only positive number values are accepted
per_pageintIndicates a page size (number of items)

Return Type

ListFaxCoverPagesResponse

Example Usage Code Snippet

from ring_central import RingCentral, Environment

sdk = RingCentral(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value
)

result = sdk.fax.list_fax_cover_pages(
page=1,
per_page=100
)

print(result)

Build Your Own SDKs with  liblab

Build developer friendly SDKs in minutes from your APIs

Start for Free →