Package com.ringcentral.definitions

Class MessageStoreCallerInfoResponseTo

java.lang.Object

com.ringcentral.definitions.MessageStoreCallerInfoResponseTo

public class MessageStoreCallerInfoResponseTo
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
String	extensionId
String	extensionNumber	Extension short number (usually 3 or 4 digits).
String	faxErrorCode	Enum: AllLinesInUse, Undefined, NoFaxSendPermission, NoInternationalPermission, NoFaxMachine, NoAnswer, LineBusy, CallerHungUp, NotEnoughCredits, SentPartially, InternationalCallingDisabled, DestinationCountryDisabled, UnknownCountryCode, NotAccepted, InvalidNumber, CallDeclined, TooManyCallsPerLine, CallFailed, RenderingFailed, TooManyPages, ReturnToDBQueue, NoCallTime, WrongNumber, ProhibitedNumber, InternalError, FaxSendingProhibited, ThePhoneIsBlacklisted, UserNotFound, ConvertError, DBGeneralError, SkypeBillingFailed, AccountSuspended, ProhibitedDestination, InternationalDisabled
String	location	Contains party location (city, state) if one can be determined from a phone number.
String	messageStatus	Message status.
String	name	Symbolic name associated with a party.
String	phoneNumber	Phone number of a party.
Boolean	target	The `true` value specifies that message is sent exactly to this recipient.

Constructor Summary

Constructors

Constructor	Description
MessageStoreCallerInfoResponseTo()

Method Summary

Modifier and Type	Method	Description
MessageStoreCallerInfoResponseTo	extensionId(String extensionId)
MessageStoreCallerInfoResponseTo	extensionNumber(String extensionNumber)
MessageStoreCallerInfoResponseTo	faxErrorCode(String faxErrorCode)
MessageStoreCallerInfoResponseTo	location(String location)
MessageStoreCallerInfoResponseTo	messageStatus(String messageStatus)
MessageStoreCallerInfoResponseTo	name(String name)
MessageStoreCallerInfoResponseTo	phoneNumber(String phoneNumber)
MessageStoreCallerInfoResponseTo	target(Boolean target)

Methods inherited from class java.lang.Object

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

Field Details

extensionNumber

public String extensionNumber

Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager messages

extensionId

public String extensionId

location

public String location

Contains party location (city, state) if one can be determined from a phone number. This property is filled only when `phoneNumber` is not empty and a server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)

target

public Boolean target

The `true` value specifies that message is sent exactly to this recipient. Returned in the `to` field for group MMS. Useful if one extension has several phone numbers'

messageStatus

public String messageStatus

Message status. Different message types may have different allowed status values. For outbound faxes the aggregated message status is returned. If, for outbound message, a status for at least one recipient is 'Queued', then the 'Queued' value is returned. If a status for at least one recipient is 'SendingFailed', then the 'SendingFailed' value is returned. In other cases the 'Sent' status is returned Enum: Queued, Sent, Delivered, DeliveryFailed, SendingFailed, Received

faxErrorCode

public String faxErrorCode

Enum: AllLinesInUse, Undefined, NoFaxSendPermission, NoInternationalPermission, NoFaxMachine, NoAnswer, LineBusy, CallerHungUp, NotEnoughCredits, SentPartially, InternationalCallingDisabled, DestinationCountryDisabled, UnknownCountryCode, NotAccepted, InvalidNumber, CallDeclined, TooManyCallsPerLine, CallFailed, RenderingFailed, TooManyPages, ReturnToDBQueue, NoCallTime, WrongNumber, ProhibitedNumber, InternalError, FaxSendingProhibited, ThePhoneIsBlacklisted, UserNotFound, ConvertError, DBGeneralError, SkypeBillingFailed, AccountSuspended, ProhibitedDestination, InternationalDisabled

name

public String name

Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then

phoneNumber

public String phoneNumber

Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS

Constructor Details

MessageStoreCallerInfoResponseTo

public MessageStoreCallerInfoResponseTo()

Method Details

extensionNumber

public MessageStoreCallerInfoResponseTo extensionNumber(String extensionNumber)

extensionId

public MessageStoreCallerInfoResponseTo extensionId(String extensionId)

location

public MessageStoreCallerInfoResponseTo location(String location)

target

public MessageStoreCallerInfoResponseTo target(Boolean target)

messageStatus

public MessageStoreCallerInfoResponseTo messageStatus(String messageStatus)

faxErrorCode

public MessageStoreCallerInfoResponseTo faxErrorCode(String faxErrorCode)

name

public MessageStoreCallerInfoResponseTo name(String name)

phoneNumber

public MessageStoreCallerInfoResponseTo phoneNumber(String phoneNumber)