Twilio.Queues.Members (twilio v0.2.0)

Copy Markdown

API calls: list, retrieve, update.

Summary

Functions

Retrieve the members of the queue

Like list/3, but returns every item, from every page: a lazy stream of Twilio.Schemas.Member.t() that fetches pages as it is read.

Fetch a specific member from the queue

Dequeue a member from a queue and have the member's call begin executing the TwiML document at that URL

Functions

list(queue_sid, params \\ %{}, opts \\ [])

Retrieve the members of the queue

GET /2010-04-01/Accounts/{AccountSid}/Queues/{QueueSid}/Members.json

Path parameters

  • queue_sid (required) - The SID of the Queue in which to find the members

{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.

Parameters

  • page_size - How many resources to return in each list page. The default is 50, and the maximum is 1000.
  • page - The page index. This value is simply for client state.
  • page_token - The page token. This is provided by the API.

To read every item across all pages, use list_all.

list!(queue_sid, params \\ %{}, opts \\ [])

Like list/3, but returns the result or raises Infusion.Runtime.Error.

list_all(queue_sid, params \\ %{}, opts \\ [])

@spec list_all(String.t(), map() | keyword(), keyword()) ::
  {:ok, Enumerable.t()} | {:error, Infusion.Runtime.Error.t()}

Like list/3, but returns every item, from every page: a lazy stream of Twilio.Schemas.Member.t() that fetches pages as it is read.

The first page is fetched right away, so its errors are returned; a later page that fails raises Infusion.Runtime.Error. Stopping early (Enum.take/2) fetches no more pages.

list_all!(queue_sid, params \\ %{}, opts \\ [])

@spec list_all!(String.t(), map() | keyword(), keyword()) :: Enumerable.t()

Like list_all/3, but returns the stream or raises Infusion.Runtime.Error.

retrieve(queue_sid, call_sid, opts \\ [])

@spec retrieve(String.t(), String.t(), keyword()) ::
  {:ok, Twilio.Schemas.Member.t()} | {:error, Infusion.Runtime.Error.t()}

Fetch a specific member from the queue

GET /2010-04-01/Accounts/{AccountSid}/Queues/{QueueSid}/Members/{CallSid}.json

Path parameters

  • queue_sid (required) - The SID of the Queue in which to find the members to fetch.
  • call_sid (required) - The Call SID of the resource(s) to fetch.

{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.

retrieve!(queue_sid, call_sid, opts \\ [])

@spec retrieve!(String.t(), String.t(), keyword()) :: Twilio.Schemas.Member.t()

Like retrieve/3, but returns the result or raises Infusion.Runtime.Error.

update(queue_sid, call_sid, params \\ %{}, opts \\ [])

@spec update(String.t(), String.t(), map() | keyword(), keyword()) ::
  {:ok, Twilio.Schemas.Member.t()} | {:error, Infusion.Runtime.Error.t()}

Dequeue a member from a queue and have the member's call begin executing the TwiML document at that URL

POST /2010-04-01/Accounts/{AccountSid}/Queues/{QueueSid}/Members/{CallSid}.json

Path parameters

  • queue_sid (required) - The SID of the Queue in which to find the members to update.
  • call_sid (required) - The Call SID of the resource(s) to update.

{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.

Parameters

  • method - How to pass the update request data. Can be GET or POST and the default is POST. POST sends the data as encoded form data and GET sends the data as query parameters.
  • url (required) - The absolute URL of the Queue resource.

update!(queue_sid, call_sid, params \\ %{}, opts \\ [])

@spec update!(String.t(), String.t(), map() | keyword(), keyword()) ::
  Twilio.Schemas.Member.t()

Like update/4, but returns the result or raises Infusion.Runtime.Error.