github.com/twilio/twilio-go@v1.20.1/rest/taskrouter/v1/docs/WorkspacesWorkersReservationsApi.md (about)

     1  # WorkspacesWorkersReservationsApi
     2  
     3  All URIs are relative to *https://taskrouter.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**FetchWorkerReservation**](WorkspacesWorkersReservationsApi.md#FetchWorkerReservation) | **Get** /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Reservations/{Sid} | 
     8  [**ListWorkerReservation**](WorkspacesWorkersReservationsApi.md#ListWorkerReservation) | **Get** /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Reservations | 
     9  [**UpdateWorkerReservation**](WorkspacesWorkersReservationsApi.md#UpdateWorkerReservation) | **Post** /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Reservations/{Sid} | 
    10  
    11  
    12  
    13  ## FetchWorkerReservation
    14  
    15  > TaskrouterV1WorkerReservation FetchWorkerReservation(ctx, WorkspaceSidWorkerSidSid)
    16  
    17  
    18  
    19  
    20  
    21  ### Path Parameters
    22  
    23  
    24  Name | Type | Description
    25  ------------- | ------------- | -------------
    26  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    27  **WorkspaceSid** | **string** | The SID of the Workspace with the WorkerReservation resource to fetch.
    28  **WorkerSid** | **string** | The SID of the reserved Worker resource with the WorkerReservation resource to fetch.
    29  **Sid** | **string** | The SID of the WorkerReservation resource to fetch.
    30  
    31  ### Other Parameters
    32  
    33  Other parameters are passed through a pointer to a FetchWorkerReservationParams struct
    34  
    35  
    36  Name | Type | Description
    37  ------------- | ------------- | -------------
    38  
    39  ### Return type
    40  
    41  [**TaskrouterV1WorkerReservation**](TaskrouterV1WorkerReservation.md)
    42  
    43  ### Authorization
    44  
    45  [accountSid_authToken](../README.md#accountSid_authToken)
    46  
    47  ### HTTP request headers
    48  
    49  - **Content-Type**: Not defined
    50  - **Accept**: application/json
    51  
    52  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    53  [[Back to Model list]](../README.md#documentation-for-models)
    54  [[Back to README]](../README.md)
    55  
    56  
    57  ## ListWorkerReservation
    58  
    59  > []TaskrouterV1WorkerReservation ListWorkerReservation(ctx, WorkspaceSidWorkerSidoptional)
    60  
    61  
    62  
    63  
    64  
    65  ### Path Parameters
    66  
    67  
    68  Name | Type | Description
    69  ------------- | ------------- | -------------
    70  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    71  **WorkspaceSid** | **string** | The SID of the Workspace with the WorkerReservation resources to read.
    72  **WorkerSid** | **string** | The SID of the reserved Worker resource with the WorkerReservation resources to read.
    73  
    74  ### Other Parameters
    75  
    76  Other parameters are passed through a pointer to a ListWorkerReservationParams struct
    77  
    78  
    79  Name | Type | Description
    80  ------------- | ------------- | -------------
    81  **ReservationStatus** | **string** | Returns the list of reservations for a worker with a specified ReservationStatus. Can be: `pending`, `accepted`, `rejected`, `timeout`, `canceled`, or `rescinded`.
    82  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
    83  **Limit** | **int** | Max number of records to return.
    84  
    85  ### Return type
    86  
    87  [**[]TaskrouterV1WorkerReservation**](TaskrouterV1WorkerReservation.md)
    88  
    89  ### Authorization
    90  
    91  [accountSid_authToken](../README.md#accountSid_authToken)
    92  
    93  ### HTTP request headers
    94  
    95  - **Content-Type**: Not defined
    96  - **Accept**: application/json
    97  
    98  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    99  [[Back to Model list]](../README.md#documentation-for-models)
   100  [[Back to README]](../README.md)
   101  
   102  
   103  ## UpdateWorkerReservation
   104  
   105  > TaskrouterV1WorkerReservation UpdateWorkerReservation(ctx, WorkspaceSidWorkerSidSidoptional)
   106  
   107  
   108  
   109  
   110  
   111  ### Path Parameters
   112  
   113  
   114  Name | Type | Description
   115  ------------- | ------------- | -------------
   116  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   117  **WorkspaceSid** | **string** | The SID of the Workspace with the WorkerReservation resources to update.
   118  **WorkerSid** | **string** | The SID of the reserved Worker resource with the WorkerReservation resources to update.
   119  **Sid** | **string** | The SID of the WorkerReservation resource to update.
   120  
   121  ### Other Parameters
   122  
   123  Other parameters are passed through a pointer to a UpdateWorkerReservationParams struct
   124  
   125  
   126  Name | Type | Description
   127  ------------- | ------------- | -------------
   128  **IfMatch** | **string** | The If-Match HTTP request header
   129  **ReservationStatus** | **string** | 
   130  **WorkerActivitySid** | **string** | The new worker activity SID if rejecting a reservation.
   131  **Instruction** | **string** | The assignment instruction for the reservation.
   132  **DequeuePostWorkActivitySid** | **string** | The SID of the Activity resource to start after executing a Dequeue instruction.
   133  **DequeueFrom** | **string** | The caller ID of the call to the worker when executing a Dequeue instruction.
   134  **DequeueRecord** | **string** | Whether to record both legs of a call when executing a Dequeue instruction or which leg to record.
   135  **DequeueTimeout** | **int** | The timeout for call when executing a Dequeue instruction.
   136  **DequeueTo** | **string** | The contact URI of the worker when executing a Dequeue instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) formatted phone number, depending on the destination.
   137  **DequeueStatusCallbackUrl** | **string** | The callback URL for completed call event when executing a Dequeue instruction.
   138  **CallFrom** | **string** | The Caller ID of the outbound call when executing a Call instruction.
   139  **CallRecord** | **string** | Whether to record both legs of a call when executing a Call instruction.
   140  **CallTimeout** | **int** | The timeout for a call when executing a Call instruction.
   141  **CallTo** | **string** | The contact URI of the worker when executing a Call instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) formatted phone number, depending on the destination.
   142  **CallUrl** | **string** | TwiML URI executed on answering the worker's leg as a result of the Call instruction.
   143  **CallStatusCallbackUrl** | **string** | The URL to call for the completed call event when executing a Call instruction.
   144  **CallAccept** | **bool** | Whether to accept a reservation when executing a Call instruction.
   145  **RedirectCallSid** | **string** | The Call SID of the call parked in the queue when executing a Redirect instruction.
   146  **RedirectAccept** | **bool** | Whether the reservation should be accepted when executing a Redirect instruction.
   147  **RedirectUrl** | **string** | TwiML URI to redirect the call to when executing the Redirect instruction.
   148  **To** | **string** | The Contact URI of the worker when executing a Conference instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) formatted phone number, depending on the destination.
   149  **From** | **string** | The caller ID of the call to the worker when executing a Conference instruction.
   150  **StatusCallback** | **string** | The URL we should call using the `status_callback_method` to send status information to your application.
   151  **StatusCallbackMethod** | **string** | The HTTP method we should use to call `status_callback`. Can be: `POST` or `GET` and the default is `POST`.
   152  **StatusCallbackEvent** | [**[]WorkerReservationEnumCallStatus**](WorkerReservationEnumCallStatus.md) | The call progress events that we will send to `status_callback`. Can be: `initiated`, `ringing`, `answered`, or `completed`.
   153  **Timeout** | **int** | The timeout for a call when executing a Conference instruction.
   154  **Record** | **bool** | Whether to record the participant and their conferences, including the time between conferences. Can be `true` or `false` and the default is `false`.
   155  **Muted** | **bool** | Whether the agent is muted in the conference. Defaults to `false`.
   156  **Beep** | **string** | Whether to play a notification beep when the participant joins or when to play a beep. Can be: `true`, `false`, `onEnter`, or `onExit`. The default value is `true`.
   157  **StartConferenceOnEnter** | **bool** | Whether to start the conference when the participant joins, 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.
   158  **EndConferenceOnExit** | **bool** | Whether to end the conference when the agent leaves.
   159  **WaitUrl** | **string** | The URL we should call using the `wait_method` for the music to play while participants are waiting for the conference to start. The default value is the URL of our standard hold music. [Learn more about hold music](https://www.twilio.com/labs/twimlets/holdmusic).
   160  **WaitMethod** | **string** | The HTTP method we should use to call `wait_url`. Can be `GET` or `POST` and the default is `POST`. When using a static audio file, this should be `GET` so that we can cache the file.
   161  **EarlyMedia** | **bool** | Whether to allow an agent to hear the state of the outbound call, including ringing or disconnect messages. The default is `true`.
   162  **MaxParticipants** | **int** | The maximum number of participants allowed in the conference. Can be a positive integer from `2` to `250`. The default value is `250`.
   163  **ConferenceStatusCallback** | **string** | The URL we should call using the `conference_status_callback_method` when the conference events in `conference_status_callback_event` occur. Only the value set by the first participant to join the conference is used. Subsequent `conference_status_callback` values are ignored.
   164  **ConferenceStatusCallbackMethod** | **string** | The HTTP method we should use to call `conference_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.
   165  **ConferenceStatusCallbackEvent** | [**[]WorkerReservationEnumConferenceEvent**](WorkerReservationEnumConferenceEvent.md) | The conference status events that we will send to `conference_status_callback`. Can be: `start`, `end`, `join`, `leave`, `mute`, `hold`, `speaker`.
   166  **ConferenceRecord** | **string** | Whether to record the conference the participant is joining or when to record the conference. Can be: `true`, `false`, `record-from-start`, and `do-not-record`. The default value is `false`.
   167  **ConferenceTrim** | **string** | Whether to trim leading and trailing silence from your recorded conference audio files. Can be: `trim-silence` or `do-not-trim` and defaults to `trim-silence`.
   168  **RecordingChannels** | **string** | The recording channels for the final recording. Can be: `mono` or `dual` and the default is `mono`.
   169  **RecordingStatusCallback** | **string** | The URL that we should call using the `recording_status_callback_method` when the recording status changes.
   170  **RecordingStatusCallbackMethod** | **string** | The HTTP method we should use when we call `recording_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.
   171  **ConferenceRecordingStatusCallback** | **string** | The URL we should call using the `conference_recording_status_callback_method` when the conference recording is available.
   172  **ConferenceRecordingStatusCallbackMethod** | **string** | The HTTP method we should use to call `conference_recording_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.
   173  **Region** | **string** | The [region](https://support.twilio.com/hc/en-us/articles/223132167-How-global-low-latency-routing-and-region-selection-work-for-conferences-and-Client-calls) where we should mix the recorded audio. Can be:`us1`, `ie1`, `de1`, `sg1`, `br1`, `au1`, or `jp1`.
   174  **SipAuthUsername** | **string** | The SIP username used for authentication.
   175  **SipAuthPassword** | **string** | The SIP password for authentication.
   176  **DequeueStatusCallbackEvent** | **[]string** | The call progress events sent via webhooks as a result of a Dequeue instruction.
   177  **PostWorkActivitySid** | **string** | The new worker activity SID after executing a Conference instruction.
   178  **EndConferenceOnCustomerExit** | **bool** | Whether to end the conference when the customer leaves.
   179  **BeepOnCustomerEntrance** | **bool** | Whether to play a notification beep when the customer joins.
   180  **JitterBufferSize** | **string** | The jitter buffer size for conference. Can be: `small`, `medium`, `large`, `off`.
   181  
   182  ### Return type
   183  
   184  [**TaskrouterV1WorkerReservation**](TaskrouterV1WorkerReservation.md)
   185  
   186  ### Authorization
   187  
   188  [accountSid_authToken](../README.md#accountSid_authToken)
   189  
   190  ### HTTP request headers
   191  
   192  - **Content-Type**: application/x-www-form-urlencoded
   193  - **Accept**: application/json
   194  
   195  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   196  [[Back to Model list]](../README.md#documentation-for-models)
   197  [[Back to README]](../README.md)
   198