Twilio. Queues
(twilio v0.2.0)
Copy Markdown
API calls: create, delete, list, retrieve, update.
Summary
Functions
Create a queue
Like create/2, but returns the result or raises Infusion.Runtime.Error.
Remove an empty queue
Like delete/2, but returns the result or raises Infusion.Runtime.Error.
Retrieve a list of queues belonging to the account used to make the request
Like list/2, but returns the result or raises Infusion.Runtime.Error.
Like list/2, but returns every item, from every page: a lazy stream of Twilio.Schemas.Queue.t() that fetches pages as it is read.
Like list_all/2, but returns the stream or raises Infusion.Runtime.Error.
Fetch an instance of a queue identified by the QueueSid
Like retrieve/2, but returns the result or raises Infusion.Runtime.Error.
Update the queue with the new parameters
Like update/3, but returns the result or raises Infusion.Runtime.Error.
Functions
@spec create(map() | keyword(), keyword()) :: {:ok, Twilio.Schemas.Queue.t()} | {:error, Infusion.Runtime.Error.t()}
Create a queue
POST /2010-04-01/Accounts/{AccountSid}/Queues.json
{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.
Parameters
friendly_name(required) - A descriptive string that you created to describe this resource. It can be up to 64 characters long.max_size- The maximum number of calls allowed to be in the queue. The default is 1000. The maximum is 5000.
@spec create!(map() | keyword(), keyword()) :: Twilio.Schemas.Queue.t()
Like create/2, but returns the result or raises Infusion.Runtime.Error.
@spec delete(String.t(), keyword()) :: {:ok, nil} | {:error, Infusion.Runtime.Error.t()}
Remove an empty queue
DELETE /2010-04-01/Accounts/{AccountSid}/Queues/{Sid}.json
Path parameters
sid(required) - The Twilio-provided string that uniquely identifies the Queue resource to delete
{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.
Like delete/2, but returns the result or raises Infusion.Runtime.Error.
@spec list(map() | keyword(), keyword()) :: {:ok, Twilio.Schemas.QueuesListResponse.t()} | {:error, Infusion.Runtime.Error.t()}
Retrieve a list of queues belonging to the account used to make the request
GET /2010-04-01/Accounts/{AccountSid}/Queues.json
{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.
@spec list!(map() | keyword(), keyword()) :: Twilio.Schemas.QueuesListResponse.t()
Like list/2, but returns the result or raises Infusion.Runtime.Error.
@spec list_all(map() | keyword(), keyword()) :: {:ok, Enumerable.t()} | {:error, Infusion.Runtime.Error.t()}
Like list/2, but returns every item, from every page: a lazy stream of Twilio.Schemas.Queue.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.
@spec list_all!(map() | keyword(), keyword()) :: Enumerable.t()
Like list_all/2, but returns the stream or raises Infusion.Runtime.Error.
@spec retrieve(String.t(), keyword()) :: {:ok, Twilio.Schemas.Queue.t()} | {:error, Infusion.Runtime.Error.t()}
Fetch an instance of a queue identified by the QueueSid
GET /2010-04-01/Accounts/{AccountSid}/Queues/{Sid}.json
Path parameters
sid(required) - The Twilio-provided string that uniquely identifies the Queue resource to fetch
{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.
@spec retrieve!(String.t(), keyword()) :: Twilio.Schemas.Queue.t()
Like retrieve/2, but returns the result or raises Infusion.Runtime.Error.
@spec update(String.t(), map() | keyword(), keyword()) :: {:ok, Twilio.Schemas.Queue.t()} | {:error, Infusion.Runtime.Error.t()}
Update the queue with the new parameters
POST /2010-04-01/Accounts/{AccountSid}/Queues/{Sid}.json
Path parameters
sid(required) - The Twilio-provided string that uniquely identifies the Queue resource to update
{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.
Parameters
friendly_name- A descriptive string that you created to describe this resource. It can be up to 64 characters long.max_size- The maximum number of calls allowed to be in the queue. The default is 1000. The maximum is 5000.
@spec update!(String.t(), map() | keyword(), keyword()) :: Twilio.Schemas.Queue.t()
Like update/3, but returns the result or raises Infusion.Runtime.Error.