Package com.ringcentral.definitions

Class CreateFaxMessageRequest

java.lang.Object

com.ringcentral.definitions.CreateFaxMessageRequest

public class CreateFaxMessageRequest
extends Object

Request body for operation createFaxMessage

Field Summary

Fields

Modifier and Type	Field	Description
Attachment[]	attachments	Required
Long	coverIndex	Cover page identifier.
String	coverPageText	Cover page text, entered by a fax sender and printed on a cover page.
String	faxResolution	Fax only.
String	isoCode	Two-letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format Example: US
String	sendTime	Timestamp to send a fax at.
FaxReceiver[]	to	Recipient's phone number(s) Required

Constructor Summary

Constructors

Constructor	Description
CreateFaxMessageRequest()

Method Summary

Modifier and Type	Method	Description
CreateFaxMessageRequest	attachments(Attachment[] attachments)
CreateFaxMessageRequest	coverIndex(Long coverIndex)
CreateFaxMessageRequest	coverPageText(String coverPageText)
CreateFaxMessageRequest	faxResolution(String faxResolution)
CreateFaxMessageRequest	isoCode(String isoCode)
CreateFaxMessageRequest	sendTime(String sendTime)
CreateFaxMessageRequest	to(FaxReceiver[] to)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

faxResolution

public String faxResolution

Fax only. Resolution of a fax message. 'High' for black and white image scanned at 200 dpi, 'Low' for black and white image scanned at 100 dpi Enum: High, Low

to

public FaxReceiver[] to

Recipient's phone number(s) Required

sendTime

public String sendTime

Timestamp to send a fax at. If not specified, current or the past a fax message is sent immediately Format: date-time

isoCode

public String isoCode

Two-letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format Example: US

coverIndex

public Long coverIndex

Cover page identifier. If `coverIndex` is set to '0' (zero) a cover page is not attached. For a list of available cover page identifiers (1-13) please call the Fax Cover Pages method. If not specified, the default cover page is attached (which is configured in 'Outbound Fax Settings') Format: int32

coverPageText

public String coverPageText

Cover page text, entered by a fax sender and printed on a cover page. Maximum length is limited to 1024 symbols

attachments

public Attachment[] attachments

Required

Constructor Details

CreateFaxMessageRequest

public CreateFaxMessageRequest()

Method Details

faxResolution

public CreateFaxMessageRequest faxResolution(String faxResolution)

to

public CreateFaxMessageRequest to(FaxReceiver[] to)

sendTime

public CreateFaxMessageRequest sendTime(String sendTime)

isoCode

public CreateFaxMessageRequest isoCode(String isoCode)

coverIndex

public CreateFaxMessageRequest coverIndex(Long coverIndex)

coverPageText

public CreateFaxMessageRequest coverPageText(String coverPageText)

attachments

public CreateFaxMessageRequest attachments(Attachment[] attachments)