Twilio.Schemas.Participant (twilio v0.2.0)

Copy Markdown

Fields

  • account_sid - The SID of the Account that created the Participant resource.
  • call_sid - The SID of the Call the Participant resource is associated with.
  • call_sid_to_coach - The SID of the participant who is being coached. The participant being coached is the only participant who can hear the participant who is coaching.
  • coaching - Whether the participant is coaching another call. Can be: true or false. If not present, defaults to false unless call_sid_to_coach is defined. If true, call_sid_to_coach must be defined.
  • conference_sid - The SID of the conference the participant is in.
  • date_created - The date and time in GMT that the resource was created specified in RFC 2822 format.
  • date_updated - The date and time in GMT that the resource was last updated specified in RFC 2822 format.
  • end_conference_on_exit - Whether the conference ends when the participant leaves. Can be: true or false and the default is false. If true, the conference ends and all other participants drop out when the participant leaves.
  • hold - Whether the participant is on hold. Can be true or false.
  • label - The user-specified label of this participant, if one was given when the participant was created. This may be used to fetch, update or delete the participant.
  • muted - Whether the participant is muted. Can be true or false.
  • queue_time - The wait time in milliseconds before participant's call is placed. Only available in the response to a create participant request.
  • start_conference_on_enter - Whether the conference starts when the participant joins the conference, if it has not already started. Can be: true or false and the default is true. If false and the conference has not started, the participant is muted and hears background music until another participant starts the conference.
  • status
  • uri - The URI of the resource, relative to https://api.twilio.com.

Summary

Types

t()

Functions

decode(json)

Decodes parsed JSON into this struct.

Types

t()

@type t() :: %Twilio.Schemas.Participant{
  __extra__: %{optional(String.t()) => term()},
  __present__: [atom()],
  account_sid: String.t() | nil,
  call_sid: String.t() | nil,
  call_sid_to_coach: String.t() | nil,
  coaching: boolean() | nil,
  conference_sid: String.t() | nil,
  date_created: String.t() | nil,
  date_updated: String.t() | nil,
  end_conference_on_exit: boolean() | nil,
  hold: boolean() | nil,
  label: String.t() | nil,
  muted: boolean() | nil,
  queue_time: String.t() | nil,
  start_conference_on_enter: boolean() | nil,
  status: Twilio.Schemas.ParticipantEnumStatus.t() | nil,
  uri: String.t() | nil
}

Functions

decode(json)

@spec decode(term()) :: t() | term()

Decodes parsed JSON into this struct.