class Twilio::QueuesApi
- Twilio::QueuesApi
- Reference
- Object
Defined in:
twilio/api/queues_api.crConstant Summary
-
CREATE_QUEUE_MAX_LENGTH_FOR_ACCOUNT_SID =
34 -
CREATE_QUEUE_MIN_LENGTH_FOR_ACCOUNT_SID =
34 -
CREATE_QUEUE_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/ -
DELETE_QUEUE_MAX_LENGTH_FOR_ACCOUNT_SID =
34 -
DELETE_QUEUE_MAX_LENGTH_FOR_SID =
34 -
DELETE_QUEUE_MIN_LENGTH_FOR_ACCOUNT_SID =
34 -
DELETE_QUEUE_MIN_LENGTH_FOR_SID =
34 -
DELETE_QUEUE_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/ -
DELETE_QUEUE_PATTERN_FOR_SID =
/^QU[0-9a-fA-F]{32}$/ -
FETCH_MEMBER_MAX_LENGTH_FOR_ACCOUNT_SID =
34 -
FETCH_MEMBER_MAX_LENGTH_FOR_QUEUE_SID =
34 -
FETCH_MEMBER_MIN_LENGTH_FOR_ACCOUNT_SID =
34 -
FETCH_MEMBER_MIN_LENGTH_FOR_QUEUE_SID =
34 -
FETCH_MEMBER_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/ -
FETCH_MEMBER_PATTERN_FOR_QUEUE_SID =
/^QU[0-9a-fA-F]{32}$/ -
FETCH_QUEUE_MAX_LENGTH_FOR_ACCOUNT_SID =
34 -
FETCH_QUEUE_MAX_LENGTH_FOR_SID =
34 -
FETCH_QUEUE_MIN_LENGTH_FOR_ACCOUNT_SID =
34 -
FETCH_QUEUE_MIN_LENGTH_FOR_SID =
34 -
FETCH_QUEUE_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/ -
FETCH_QUEUE_PATTERN_FOR_SID =
/^QU[0-9a-fA-F]{32}$/ -
LIST_MEMBER_MAX_FOR_PAGE_SIZE =
Int32.new("1000") -
LIST_MEMBER_MAX_LENGTH_FOR_ACCOUNT_SID =
34 -
LIST_MEMBER_MAX_LENGTH_FOR_QUEUE_SID =
34 -
LIST_MEMBER_MIN_FOR_PAGE_SIZE =
Int32.new("1") -
LIST_MEMBER_MIN_LENGTH_FOR_ACCOUNT_SID =
34 -
LIST_MEMBER_MIN_LENGTH_FOR_QUEUE_SID =
34 -
LIST_MEMBER_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/ -
LIST_MEMBER_PATTERN_FOR_QUEUE_SID =
/^QU[0-9a-fA-F]{32}$/ -
LIST_QUEUE_MAX_FOR_PAGE_SIZE =
Int32.new("1000") -
LIST_QUEUE_MAX_LENGTH_FOR_ACCOUNT_SID =
34 -
LIST_QUEUE_MIN_FOR_PAGE_SIZE =
Int32.new("1") -
LIST_QUEUE_MIN_LENGTH_FOR_ACCOUNT_SID =
34 -
LIST_QUEUE_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/ -
UPDATE_MEMBER_MAX_LENGTH_FOR_ACCOUNT_SID =
34 -
UPDATE_MEMBER_MAX_LENGTH_FOR_QUEUE_SID =
34 -
UPDATE_MEMBER_MIN_LENGTH_FOR_ACCOUNT_SID =
34 -
UPDATE_MEMBER_MIN_LENGTH_FOR_QUEUE_SID =
34 -
UPDATE_MEMBER_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/ -
UPDATE_MEMBER_PATTERN_FOR_QUEUE_SID =
/^QU[0-9a-fA-F]{32}$/ -
UPDATE_QUEUE_MAX_LENGTH_FOR_ACCOUNT_SID =
34 -
UPDATE_QUEUE_MAX_LENGTH_FOR_SID =
34 -
UPDATE_QUEUE_MIN_LENGTH_FOR_ACCOUNT_SID =
34 -
UPDATE_QUEUE_MIN_LENGTH_FOR_SID =
34 -
UPDATE_QUEUE_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/ -
UPDATE_QUEUE_PATTERN_FOR_SID =
/^QU[0-9a-fA-F]{32}$/
Constructors
Instance Method Summary
- #account_sid : String
- #account_sid=(account_sid : String)
- #api_client : ApiClient
- #api_client=(api_client : ApiClient)
-
#build_api_request_for_create_queue(*, account_sid : String | Nil = @account_sid, friendly_name : String | Nil = nil, max_size : Int32 | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_delete_queue(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_fetch_member(*, account_sid : String | Nil = @account_sid, queue_sid : String | Nil = nil, call_sid : String | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_fetch_queue(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_list_member(*, account_sid : String | Nil = @account_sid, queue_sid : String | Nil = nil, page_size : Int32 | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_list_queue(*, account_sid : String | Nil = @account_sid, page_size : Int32 | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_update_member(*, account_sid : String | Nil = @account_sid, queue_sid : String | Nil = nil, call_sid : String | Nil = nil, url : String | Nil = nil, method : Twilio::HttpMethod | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_update_queue(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, friendly_name : String | Nil = nil, max_size : Int32 | Nil = nil) : Crest::Request
@return Crest::Request
- #client_side_validation?(*args, **options)
- #client_side_validation?(*args, **options, &)
-
#create_queue(*, account_sid : String | Nil = @account_sid, friendly_name : String | Nil = nil, max_size : Int32 | Nil = nil) : Twilio::Queue
Create a queue @required @param account_sid [String?] The SID of the Account that will create the resource.
-
#create_queue(*, account_sid : String | Nil = @account_sid, friendly_name : String | Nil = nil, max_size : Int32 | Nil = nil, &block : Crest::Response -> ) : Nil
Create a queue @required @param account_sid [String?] The SID of the Account that will create the resource.
-
#create_queue_with_http_info(*, account_sid : String | Nil = @account_sid, friendly_name : String | Nil = nil, max_size : Int32 | Nil = nil) : Tuple(Twilio::Queue, Int32, Hash(String, Array(String) | String))
Create a queue @required @param account_sid [String?] The SID of the Account that will create the resource.
- #debugging?(*args, **options)
- #debugging?(*args, **options, &)
-
#delete_queue(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Nil
Remove an empty queue @required @param account_sid [String?] The SID of the Account that created the Queue resource to delete.
-
#delete_queue(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, &block : Crest::Response -> ) : Nil
Remove an empty queue @required @param account_sid [String?] The SID of the Account that created the Queue resource to delete.
-
#delete_queue_with_http_info(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Tuple(Nil, Int32, Hash(String, Array(String) | String))
Remove an empty queue @required @param account_sid [String?] The SID of the Account that created the Queue resource to delete.
-
#fetch_member(*, account_sid : String | Nil = @account_sid, queue_sid : String | Nil = nil, call_sid : String | Nil = nil) : Twilio::QueueMember
Fetch a specific member from the queue @required @param account_sid [String?] The SID of the Account that created the Member resource(s) to fetch.
-
#fetch_member(*, account_sid : String | Nil = @account_sid, queue_sid : String | Nil = nil, call_sid : String | Nil = nil, &block : Crest::Response -> ) : Nil
Fetch a specific member from the queue @required @param account_sid [String?] The SID of the Account that created the Member resource(s) to fetch.
-
#fetch_member_with_http_info(*, account_sid : String | Nil = @account_sid, queue_sid : String | Nil = nil, call_sid : String | Nil = nil) : Tuple(Twilio::QueueMember, Int32, Hash(String, Array(String) | String))
Fetch a specific member from the queue @required @param account_sid [String?] The SID of the Account that created the Member resource(s) to fetch.
-
#fetch_queue(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Twilio::Queue
Fetch an instance of a queue identified by the QueueSid @required @param account_sid [String?] The SID of the Account that created the Queue resource to fetch.
-
#fetch_queue(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, &block : Crest::Response -> ) : Nil
Fetch an instance of a queue identified by the QueueSid @required @param account_sid [String?] The SID of the Account that created the Queue resource to fetch.
-
#fetch_queue_with_http_info(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Tuple(Twilio::Queue, Int32, Hash(String, Array(String) | String))
Fetch an instance of a queue identified by the QueueSid @required @param account_sid [String?] The SID of the Account that created the Queue resource to fetch.
-
#list_member(*, account_sid : String | Nil = @account_sid, queue_sid : String | Nil = nil, page_size : Int32 | Nil = nil) : Twilio::ListMemberResponse
Retrieve the members of the queue @required @param account_sid [String?] The SID of the Account that created the Member resource(s) to read.
-
#list_member(*, account_sid : String | Nil = @account_sid, queue_sid : String | Nil = nil, page_size : Int32 | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve the members of the queue @required @param account_sid [String?] The SID of the Account that created the Member resource(s) to read.
-
#list_member_with_http_info(*, account_sid : String | Nil = @account_sid, queue_sid : String | Nil = nil, page_size : Int32 | Nil = nil) : Tuple(Twilio::ListMemberResponse, Int32, Hash(String, Array(String) | String))
Retrieve the members of the queue @required @param account_sid [String?] The SID of the Account that created the Member resource(s) to read.
-
#list_queue(*, account_sid : String | Nil = @account_sid, page_size : Int32 | Nil = nil) : Twilio::ListQueueResponse
Retrieve a list of queues belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the Queue resources to read.
-
#list_queue(*, account_sid : String | Nil = @account_sid, page_size : Int32 | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve a list of queues belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the Queue resources to read.
-
#list_queue_with_http_info(*, account_sid : String | Nil = @account_sid, page_size : Int32 | Nil = nil) : Tuple(Twilio::ListQueueResponse, Int32, Hash(String, Array(String) | String))
Retrieve a list of queues belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the Queue resources to read.
-
#update_member(*, account_sid : String | Nil = @account_sid, queue_sid : String | Nil = nil, call_sid : String | Nil = nil, url : String | Nil = nil, method : Twilio::HttpMethod | Nil = nil) : Twilio::QueueMember
Dequeue a member from a queue and have the member's call begin executing the TwiML document at that URL @required @param account_sid [String?] The SID of the Account that created the Member resource(s) to update.
-
#update_member(*, account_sid : String | Nil = @account_sid, queue_sid : String | Nil = nil, call_sid : String | Nil = nil, url : String | Nil = nil, method : Twilio::HttpMethod | Nil = nil, &block : Crest::Response -> ) : Nil
Dequeue a member from a queue and have the member's call begin executing the TwiML document at that URL @required @param account_sid [String?] The SID of the Account that created the Member resource(s) to update.
-
#update_member_with_http_info(*, account_sid : String | Nil = @account_sid, queue_sid : String | Nil = nil, call_sid : String | Nil = nil, url : String | Nil = nil, method : Twilio::HttpMethod | Nil = nil) : Tuple(Twilio::QueueMember, Int32, Hash(String, Array(String) | String))
Dequeue a member from a queue and have the member's call begin executing the TwiML document at that URL @required @param account_sid [String?] The SID of the Account that created the Member resource(s) to update.
-
#update_queue(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, friendly_name : String | Nil = nil, max_size : Int32 | Nil = nil) : Twilio::Queue
Update the queue with the new parameters @required @param account_sid [String?] The SID of the Account that created the Queue resource to update.
-
#update_queue(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, friendly_name : String | Nil = nil, max_size : Int32 | Nil = nil, &block : Crest::Response -> ) : Nil
Update the queue with the new parameters @required @param account_sid [String?] The SID of the Account that created the Queue resource to update.
-
#update_queue_with_http_info(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, friendly_name : String | Nil = nil, max_size : Int32 | Nil = nil) : Tuple(Twilio::Queue, Int32, Hash(String, Array(String) | String))
Update the queue with the new parameters @required @param account_sid [String?] The SID of the Account that created the Queue resource to update.
Constructor Detail
Instance Method Detail
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
Create a queue @required @param account_sid [String?] The SID of the Account that will create the resource. @required @param friendly_name [String?] A descriptive string that you created to describe this resource. It can be up to 64 characters long. @optional @param max_size [Int32?] The maximum number of calls allowed to be in the queue. The default is 100. The maximum is 5000. @return [Twilio::Queue]
Create a queue @required @param account_sid [String?] The SID of the Account that will create the resource. @required @param friendly_name [String?] A descriptive string that you created to describe this resource. It can be up to 64 characters long. @optional @param max_size [Int32?] The maximum number of calls allowed to be in the queue. The default is 100. The maximum is 5000. @return nil
Create a queue @required @param account_sid [String?] The SID of the Account that will create the resource. @required @param friendly_name [String?] A descriptive string that you created to describe this resource. It can be up to 64 characters long. @optional @param max_size [Int32?] The maximum number of calls allowed to be in the queue. The default is 100. The maximum is 5000. @return [Tuple(Twilio::Queue, Integer, Hash)] Twilio::Queue, response status code and response headers
Remove an empty queue @required @param account_sid [String?] The SID of the Account that created the Queue resource to delete. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Queue resource to delete @return [Nil]
Remove an empty queue @required @param account_sid [String?] The SID of the Account that created the Queue resource to delete. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Queue resource to delete @return nil
Remove an empty queue @required @param account_sid [String?] The SID of the Account that created the Queue resource to delete. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Queue resource to delete @return [Tuple(Nil, Integer, Hash)] Nil, response status code and response headers
Fetch a specific member from the queue @required @param account_sid [String?] The SID of the Account that created the Member resource(s) to fetch. @required @param queue_sid [String?] The SID of the Queue in which to find the members to fetch. @required @param call_sid [String?] The Call SID of the resource(s) to fetch. @return [Twilio::QueueMember]
Fetch a specific member from the queue @required @param account_sid [String?] The SID of the Account that created the Member resource(s) to fetch. @required @param queue_sid [String?] The SID of the Queue in which to find the members to fetch. @required @param call_sid [String?] The Call SID of the resource(s) to fetch. @return nil
Fetch a specific member from the queue @required @param account_sid [String?] The SID of the Account that created the Member resource(s) to fetch. @required @param queue_sid [String?] The SID of the Queue in which to find the members to fetch. @required @param call_sid [String?] The Call SID of the resource(s) to fetch. @return [Tuple(Twilio::QueueMember, Integer, Hash)] Twilio::QueueMember, response status code and response headers
Fetch an instance of a queue identified by the QueueSid @required @param account_sid [String?] The SID of the Account that created the Queue resource to fetch. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Queue resource to fetch @return [Twilio::Queue]
Fetch an instance of a queue identified by the QueueSid @required @param account_sid [String?] The SID of the Account that created the Queue resource to fetch. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Queue resource to fetch @return nil
Fetch an instance of a queue identified by the QueueSid @required @param account_sid [String?] The SID of the Account that created the Queue resource to fetch. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Queue resource to fetch @return [Tuple(Twilio::Queue, Integer, Hash)] Twilio::Queue, response status code and response headers
Retrieve the members of the queue @required @param account_sid [String?] The SID of the Account that created the Member resource(s) to read. @required @param queue_sid [String?] The SID of the Queue in which to find the members @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return [Twilio::ListMemberResponse]
Retrieve the members of the queue @required @param account_sid [String?] The SID of the Account that created the Member resource(s) to read. @required @param queue_sid [String?] The SID of the Queue in which to find the members @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return nil
Retrieve the members of the queue @required @param account_sid [String?] The SID of the Account that created the Member resource(s) to read. @required @param queue_sid [String?] The SID of the Queue in which to find the members @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return [Tuple(Twilio::ListMemberResponse, Integer, Hash)] Twilio::ListMemberResponse, response status code and response headers
Retrieve a list of queues belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the Queue resources to read. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return [Twilio::ListQueueResponse]
Retrieve a list of queues belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the Queue resources to read. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return nil
Retrieve a list of queues belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the Queue resources to read. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return [Tuple(Twilio::ListQueueResponse, Integer, Hash)] Twilio::ListQueueResponse, response status code and response headers
Dequeue a member from a queue and have the member's call begin executing the TwiML document at that URL @required @param account_sid [String?] The SID of the Account that created the Member resource(s) to update. @required @param queue_sid [String?] The SID of the Queue in which to find the members to update. @required @param call_sid [String?] The Call SID of the resource(s) to update. @required @param url [String?] The absolute URL of the Queue resource. @optional @param method [Twilio::HttpMethod?] @return [Twilio::QueueMember]
Dequeue a member from a queue and have the member's call begin executing the TwiML document at that URL @required @param account_sid [String?] The SID of the Account that created the Member resource(s) to update. @required @param queue_sid [String?] The SID of the Queue in which to find the members to update. @required @param call_sid [String?] The Call SID of the resource(s) to update. @required @param url [String?] The absolute URL of the Queue resource. @optional @param method [Twilio::HttpMethod?] @return nil
Dequeue a member from a queue and have the member's call begin executing the TwiML document at that URL @required @param account_sid [String?] The SID of the Account that created the Member resource(s) to update. @required @param queue_sid [String?] The SID of the Queue in which to find the members to update. @required @param call_sid [String?] The Call SID of the resource(s) to update. @required @param url [String?] The absolute URL of the Queue resource. @optional @param method [Twilio::HttpMethod?] @return [Tuple(Twilio::QueueMember, Integer, Hash)] Twilio::QueueMember, response status code and response headers
Update the queue with the new parameters @required @param account_sid [String?] The SID of the Account that created the Queue resource to update. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Queue resource to update @optional @param friendly_name [String?] A descriptive string that you created to describe this resource. It can be up to 64 characters long. @optional @param max_size [Int32?] The maximum number of calls allowed to be in the queue. The default is 100. The maximum is 5000. @return [Twilio::Queue]
Update the queue with the new parameters @required @param account_sid [String?] The SID of the Account that created the Queue resource to update. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Queue resource to update @optional @param friendly_name [String?] A descriptive string that you created to describe this resource. It can be up to 64 characters long. @optional @param max_size [Int32?] The maximum number of calls allowed to be in the queue. The default is 100. The maximum is 5000. @return nil
Update the queue with the new parameters @required @param account_sid [String?] The SID of the Account that created the Queue resource to update. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Queue resource to update @optional @param friendly_name [String?] A descriptive string that you created to describe this resource. It can be up to 64 characters long. @optional @param max_size [Int32?] The maximum number of calls allowed to be in the queue. The default is 100. The maximum is 5000. @return [Tuple(Twilio::Queue, Integer, Hash)] Twilio::Queue, response status code and response headers