github.com/twilio/twilio-go@v1.20.1/rest/intelligence/v2/docs/TranscriptsApi.md (about)

     1  # TranscriptsApi
     2  
     3  All URIs are relative to *https://intelligence.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateTranscript**](TranscriptsApi.md#CreateTranscript) | **Post** /v2/Transcripts | 
     8  [**DeleteTranscript**](TranscriptsApi.md#DeleteTranscript) | **Delete** /v2/Transcripts/{Sid} | 
     9  [**FetchTranscript**](TranscriptsApi.md#FetchTranscript) | **Get** /v2/Transcripts/{Sid} | 
    10  [**ListTranscript**](TranscriptsApi.md#ListTranscript) | **Get** /v2/Transcripts | 
    11  
    12  
    13  
    14  ## CreateTranscript
    15  
    16  > IntelligenceV2Transcript CreateTranscript(ctx, optional)
    17  
    18  
    19  
    20  Create a new Transcript for the service
    21  
    22  ### Path Parameters
    23  
    24  This endpoint does not need any path parameter.
    25  
    26  ### Other Parameters
    27  
    28  Other parameters are passed through a pointer to a CreateTranscriptParams struct
    29  
    30  
    31  Name | Type | Description
    32  ------------- | ------------- | -------------
    33  **ServiceSid** | **string** | The unique SID identifier of the Service.
    34  **Channel** | [**interface{}**](interface{}.md) | JSON object describing Media Channel including Source and Participants
    35  **CustomerKey** | **string** | Used to store client provided metadata. Maximum of 64 double-byte UTF8 characters.
    36  **MediaStartTime** | **time.Time** | The date that this Transcript's media was started, given in ISO 8601 format.
    37  
    38  ### Return type
    39  
    40  [**IntelligenceV2Transcript**](IntelligenceV2Transcript.md)
    41  
    42  ### Authorization
    43  
    44  [accountSid_authToken](../README.md#accountSid_authToken)
    45  
    46  ### HTTP request headers
    47  
    48  - **Content-Type**: application/x-www-form-urlencoded
    49  - **Accept**: application/json
    50  
    51  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    52  [[Back to Model list]](../README.md#documentation-for-models)
    53  [[Back to README]](../README.md)
    54  
    55  
    56  ## DeleteTranscript
    57  
    58  > DeleteTranscript(ctx, Sid)
    59  
    60  
    61  
    62  Delete a specific Transcript.
    63  
    64  ### Path Parameters
    65  
    66  
    67  Name | Type | Description
    68  ------------- | ------------- | -------------
    69  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    70  **Sid** | **string** | A 34 character string that uniquely identifies this Transcript.
    71  
    72  ### Other Parameters
    73  
    74  Other parameters are passed through a pointer to a DeleteTranscriptParams struct
    75  
    76  
    77  Name | Type | Description
    78  ------------- | ------------- | -------------
    79  
    80  ### Return type
    81  
    82   (empty response body)
    83  
    84  ### Authorization
    85  
    86  [accountSid_authToken](../README.md#accountSid_authToken)
    87  
    88  ### HTTP request headers
    89  
    90  - **Content-Type**: Not defined
    91  - **Accept**: Not defined
    92  
    93  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    94  [[Back to Model list]](../README.md#documentation-for-models)
    95  [[Back to README]](../README.md)
    96  
    97  
    98  ## FetchTranscript
    99  
   100  > IntelligenceV2Transcript FetchTranscript(ctx, Sid)
   101  
   102  
   103  
   104  Fetch a specific Transcript.
   105  
   106  ### Path Parameters
   107  
   108  
   109  Name | Type | Description
   110  ------------- | ------------- | -------------
   111  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   112  **Sid** | **string** | A 34 character string that uniquely identifies this Transcript.
   113  
   114  ### Other Parameters
   115  
   116  Other parameters are passed through a pointer to a FetchTranscriptParams struct
   117  
   118  
   119  Name | Type | Description
   120  ------------- | ------------- | -------------
   121  
   122  ### Return type
   123  
   124  [**IntelligenceV2Transcript**](IntelligenceV2Transcript.md)
   125  
   126  ### Authorization
   127  
   128  [accountSid_authToken](../README.md#accountSid_authToken)
   129  
   130  ### HTTP request headers
   131  
   132  - **Content-Type**: Not defined
   133  - **Accept**: application/json
   134  
   135  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   136  [[Back to Model list]](../README.md#documentation-for-models)
   137  [[Back to README]](../README.md)
   138  
   139  
   140  ## ListTranscript
   141  
   142  > []IntelligenceV2Transcript ListTranscript(ctx, optional)
   143  
   144  
   145  
   146  Retrieve a list of Transcripts for a given service.
   147  
   148  ### Path Parameters
   149  
   150  This endpoint does not need any path parameter.
   151  
   152  ### Other Parameters
   153  
   154  Other parameters are passed through a pointer to a ListTranscriptParams struct
   155  
   156  
   157  Name | Type | Description
   158  ------------- | ------------- | -------------
   159  **ServiceSid** | **string** | The unique SID identifier of the Service.
   160  **BeforeStartTime** | **string** | Filter by before StartTime.
   161  **AfterStartTime** | **string** | Filter by after StartTime.
   162  **BeforeDateCreated** | **string** | Filter by before DateCreated.
   163  **AfterDateCreated** | **string** | Filter by after DateCreated.
   164  **Status** | **string** | Filter by status.
   165  **LanguageCode** | **string** | Filter by Language Code.
   166  **SourceSid** | **string** | Filter by SourceSid.
   167  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   168  **Limit** | **int** | Max number of records to return.
   169  
   170  ### Return type
   171  
   172  [**[]IntelligenceV2Transcript**](IntelligenceV2Transcript.md)
   173  
   174  ### Authorization
   175  
   176  [accountSid_authToken](../README.md#accountSid_authToken)
   177  
   178  ### HTTP request headers
   179  
   180  - **Content-Type**: Not defined
   181  - **Accept**: application/json
   182  
   183  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   184  [[Back to Model list]](../README.md#documentation-for-models)
   185  [[Back to README]](../README.md)
   186