Skip to content

Latest commit

 

History

History
226 lines (124 loc) · 6.47 KB

AccountsQueuesApi.md

File metadata and controls

226 lines (124 loc) · 6.47 KB

AccountsQueuesApi

All URIs are relative to https://api.twilio.com

Method HTTP request Description
CreateQueue Post /2010-04-01/Accounts/{AccountSid}/Queues.json
DeleteQueue Delete /2010-04-01/Accounts/{AccountSid}/Queues/{Sid}.json
FetchQueue Get /2010-04-01/Accounts/{AccountSid}/Queues/{Sid}.json
ListQueue Get /2010-04-01/Accounts/{AccountSid}/Queues.json
UpdateQueue Post /2010-04-01/Accounts/{AccountSid}/Queues/{Sid}.json

CreateQueue

ApiV2010Queue CreateQueue(ctx, optional)

Create a queue

Path Parameters

This endpoint does not need any path parameter.

Other Parameters

Other parameters are passed through a pointer to a CreateQueueParams struct

Name Type Description
PathAccountSid string The SID of the Account that will create the resource.
FriendlyName string A descriptive string that you created to describe this resource. It can be up to 64 characters long.
MaxSize int The maximum number of calls allowed to be in the queue. The default is 1000. The maximum is 5000.

Return type

ApiV2010Queue

Authorization

accountSid_authToken

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteQueue

DeleteQueue(ctx, Sidoptional)

Remove an empty queue

Path Parameters

Name Type Description
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
Sid string The Twilio-provided string that uniquely identifies the Queue resource to delete

Other Parameters

Other parameters are passed through a pointer to a DeleteQueueParams struct

Name Type Description
PathAccountSid string The SID of the Account that created the Queue resource to delete.

Return type

(empty response body)

Authorization

accountSid_authToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FetchQueue

ApiV2010Queue FetchQueue(ctx, Sidoptional)

Fetch an instance of a queue identified by the QueueSid

Path Parameters

Name Type Description
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
Sid string The Twilio-provided string that uniquely identifies the Queue resource to fetch

Other Parameters

Other parameters are passed through a pointer to a FetchQueueParams struct

Name Type Description
PathAccountSid string The SID of the Account that created the Queue resource to fetch.

Return type

ApiV2010Queue

Authorization

accountSid_authToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListQueue

[]ApiV2010Queue ListQueue(ctx, optional)

Retrieve a list of queues belonging to the account used to make the request

Path Parameters

This endpoint does not need any path parameter.

Other Parameters

Other parameters are passed through a pointer to a ListQueueParams struct

Name Type Description
PathAccountSid string The SID of the Account that created the Queue resources to read.
PageSize int How many resources to return in each list page. The default is 50, and the maximum is 1000.
Limit int Max number of records to return.

Return type

[]ApiV2010Queue

Authorization

accountSid_authToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateQueue

ApiV2010Queue UpdateQueue(ctx, Sidoptional)

Update the queue with the new parameters

Path Parameters

Name Type Description
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
Sid string The Twilio-provided string that uniquely identifies the Queue resource to update

Other Parameters

Other parameters are passed through a pointer to a UpdateQueueParams struct

Name Type Description
PathAccountSid string The SID of the Account that created the Queue resource to update.
FriendlyName string A descriptive string that you created to describe this resource. It can be up to 64 characters long.
MaxSize int The maximum number of calls allowed to be in the queue. The default is 1000. The maximum is 5000.

Return type

ApiV2010Queue

Authorization

accountSid_authToken

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]