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

     1  # ExportsJobsApi
     2  
     3  All URIs are relative to *https://bulkexports.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateExportCustomJob**](ExportsJobsApi.md#CreateExportCustomJob) | **Post** /v1/Exports/{ResourceType}/Jobs | 
     8  [**DeleteJob**](ExportsJobsApi.md#DeleteJob) | **Delete** /v1/Exports/Jobs/{JobSid} | 
     9  [**FetchJob**](ExportsJobsApi.md#FetchJob) | **Get** /v1/Exports/Jobs/{JobSid} | 
    10  [**ListExportCustomJob**](ExportsJobsApi.md#ListExportCustomJob) | **Get** /v1/Exports/{ResourceType}/Jobs | 
    11  
    12  
    13  
    14  ## CreateExportCustomJob
    15  
    16  > BulkexportsV1ExportCustomJob CreateExportCustomJob(ctx, ResourceTypeoptional)
    17  
    18  
    19  
    20  
    21  
    22  ### Path Parameters
    23  
    24  
    25  Name | Type | Description
    26  ------------- | ------------- | -------------
    27  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    28  **ResourceType** | **string** | The type of communication – Messages or Calls, Conferences, and Participants
    29  
    30  ### Other Parameters
    31  
    32  Other parameters are passed through a pointer to a CreateExportCustomJobParams struct
    33  
    34  
    35  Name | Type | Description
    36  ------------- | ------------- | -------------
    37  **StartDay** | **string** | The start day for the custom export specified as a string in the format of yyyy-mm-dd
    38  **EndDay** | **string** | The end day for the custom export specified as a string in the format of yyyy-mm-dd. End day is inclusive and must be 2 days earlier than the current UTC day.
    39  **FriendlyName** | **string** | The friendly name specified when creating the job
    40  **WebhookUrl** | **string** | The optional webhook url called on completion of the job. If this is supplied, `WebhookMethod` must also be supplied. If you set neither webhook nor email, you will have to check your job's status manually.
    41  **WebhookMethod** | **string** | This is the method used to call the webhook on completion of the job. If this is supplied, `WebhookUrl` must also be supplied.
    42  **Email** | **string** | The optional email to send the completion notification to. You can set both webhook, and email, or one or the other. If you set neither, the job will run but you will have to query to determine your job's status.
    43  
    44  ### Return type
    45  
    46  [**BulkexportsV1ExportCustomJob**](BulkexportsV1ExportCustomJob.md)
    47  
    48  ### Authorization
    49  
    50  [accountSid_authToken](../README.md#accountSid_authToken)
    51  
    52  ### HTTP request headers
    53  
    54  - **Content-Type**: application/x-www-form-urlencoded
    55  - **Accept**: application/json
    56  
    57  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    58  [[Back to Model list]](../README.md#documentation-for-models)
    59  [[Back to README]](../README.md)
    60  
    61  
    62  ## DeleteJob
    63  
    64  > DeleteJob(ctx, JobSid)
    65  
    66  
    67  
    68  
    69  
    70  ### Path Parameters
    71  
    72  
    73  Name | Type | Description
    74  ------------- | ------------- | -------------
    75  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    76  **JobSid** | **string** | The unique string that that we created to identify the Bulk Export job
    77  
    78  ### Other Parameters
    79  
    80  Other parameters are passed through a pointer to a DeleteJobParams struct
    81  
    82  
    83  Name | Type | Description
    84  ------------- | ------------- | -------------
    85  
    86  ### Return type
    87  
    88   (empty response body)
    89  
    90  ### Authorization
    91  
    92  [accountSid_authToken](../README.md#accountSid_authToken)
    93  
    94  ### HTTP request headers
    95  
    96  - **Content-Type**: Not defined
    97  - **Accept**: Not defined
    98  
    99  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   100  [[Back to Model list]](../README.md#documentation-for-models)
   101  [[Back to README]](../README.md)
   102  
   103  
   104  ## FetchJob
   105  
   106  > BulkexportsV1Job FetchJob(ctx, JobSid)
   107  
   108  
   109  
   110  
   111  
   112  ### Path Parameters
   113  
   114  
   115  Name | Type | Description
   116  ------------- | ------------- | -------------
   117  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   118  **JobSid** | **string** | The unique string that that we created to identify the Bulk Export job
   119  
   120  ### Other Parameters
   121  
   122  Other parameters are passed through a pointer to a FetchJobParams struct
   123  
   124  
   125  Name | Type | Description
   126  ------------- | ------------- | -------------
   127  
   128  ### Return type
   129  
   130  [**BulkexportsV1Job**](BulkexportsV1Job.md)
   131  
   132  ### Authorization
   133  
   134  [accountSid_authToken](../README.md#accountSid_authToken)
   135  
   136  ### HTTP request headers
   137  
   138  - **Content-Type**: Not defined
   139  - **Accept**: application/json
   140  
   141  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   142  [[Back to Model list]](../README.md#documentation-for-models)
   143  [[Back to README]](../README.md)
   144  
   145  
   146  ## ListExportCustomJob
   147  
   148  > []BulkexportsV1ExportCustomJob ListExportCustomJob(ctx, ResourceTypeoptional)
   149  
   150  
   151  
   152  
   153  
   154  ### Path Parameters
   155  
   156  
   157  Name | Type | Description
   158  ------------- | ------------- | -------------
   159  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   160  **ResourceType** | **string** | The type of communication – Messages, Calls, Conferences, and Participants
   161  
   162  ### Other Parameters
   163  
   164  Other parameters are passed through a pointer to a ListExportCustomJobParams struct
   165  
   166  
   167  Name | Type | Description
   168  ------------- | ------------- | -------------
   169  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   170  **Limit** | **int** | Max number of records to return.
   171  
   172  ### Return type
   173  
   174  [**[]BulkexportsV1ExportCustomJob**](BulkexportsV1ExportCustomJob.md)
   175  
   176  ### Authorization
   177  
   178  [accountSid_authToken](../README.md#accountSid_authToken)
   179  
   180  ### HTTP request headers
   181  
   182  - **Content-Type**: Not defined
   183  - **Accept**: application/json
   184  
   185  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   186  [[Back to Model list]](../README.md#documentation-for-models)
   187  [[Back to README]](../README.md)
   188