Call

enfonica.voice.v1beta1. Call

Represents a Call.

Constructor

new Call(propertiesopt)

Constructs a new Call.

Parameters:
Name Type Attributes Description
properties enfonica.voice.v1beta1.ICall <optional>

Properties to set
Implements:
  • ICall

Classes

ApiCallOptions

Members

CreateMethod

CreateMethod enum.

Properties:
Name Type Description
CREATE_METHOD_UNSPECIFIED number

CREATE_METHOD_UNSPECIFIED value
INCOMING_CALL number

INCOMING_CALL value
PARENT_CALL number

PARENT_CALL value
API number

API value

Direction

Direction enum.

Properties:
Name Type Description
DIRECTION_UNSPECIFIED number

DIRECTION_UNSPECIFIED value
OUTGOING number

OUTGOING value
INCOMING number

INCOMING value

State

State enum.

Properties:
Name Type Description
STATE_UNSPECIFIED number

STATE_UNSPECIFIED value
QUEUED number

QUEUED value
STARTING number

STARTING value
RINGING number

RINGING value
IN_PROGRESS number

IN_PROGRESS value
COMPLETED number

COMPLETED value
FAILED number

FAILED value
NOT_ANSWERED number

NOT_ANSWERED value
BUSY number

BUSY value
REJECTED number

REJECTED value

Transport

Transport enum.

Properties:
Name Type Description
TRANSPORT_UNSPECIFIED number

TRANSPORT_UNSPECIFIED value
PSTN number

PSTN value
CLIENT number

CLIENT value
SIP number

SIP value

answerDuration

Call answerDuration.

answerTime

Call answerTime.

bridged

Call bridged.

createMethod

Call createMethod.

createTime

Call createTime.

direction

Call direction.

endTime

Call endTime.

errorCode

Call errorCode.

errorMessage

Call errorMessage.

from

Call from.

fromLocation

Call fromLocation.

fromZone

Call fromZone.

isPrivate

Call isPrivate.

labels

Call labels.

name

Call name.

options

Call options.

originatingCall

Call originatingCall.

price

Call price.

ringTime

Call ringTime.

sipCallId

Call sipCallId.

startTime

Call startTime.

state

Call state.

to

Call to.

transport

Call transport.

Methods

(static) create(propertiesopt) → {enfonica.voice.v1beta1.Call}

Creates a new Call instance using the specified properties.

Parameters:
Name Type Attributes Description
properties enfonica.voice.v1beta1.ICall <optional>

Properties to set
Returns:
Type Description
enfonica.voice.v1beta1.Call

Call instance

(static) decode(reader, lengthopt) → {enfonica.voice.v1beta1.Call}

Decodes a Call message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from
length number <optional>

Message length if known beforehand
Returns:
Type Description
enfonica.voice.v1beta1.Call

Call
Throws:

  • If the payload is not a reader or valid buffer

    Type
    Error

  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {enfonica.voice.v1beta1.Call}

Decodes a Call message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from
Returns:
Type Description
enfonica.voice.v1beta1.Call

Call
Throws:

  • If the payload is not a reader or valid buffer

    Type
    Error

  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified Call message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message enfonica.voice.v1beta1.ICall

Call message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to
Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified Call message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message enfonica.voice.v1beta1.ICall

Call message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to
Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {enfonica.voice.v1beta1.Call}

Creates a Call message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object
Returns:
Type Description
enfonica.voice.v1beta1.Call

Call

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a Call message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message enfonica.voice.v1beta1.Call

Call
options $protobuf.IConversionOptions <optional>

Conversion options
Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a Call message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify
Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not

toJSON() → {Object.<string, *>}

Converts this Call to JSON.

Returns:
Type Description
Object.<string, *>

JSON object