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

     1  # AttemptsApi
     2  
     3  All URIs are relative to *https://verify.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**FetchVerificationAttempt**](AttemptsApi.md#FetchVerificationAttempt) | **Get** /v2/Attempts/{Sid} | 
     8  [**ListVerificationAttempt**](AttemptsApi.md#ListVerificationAttempt) | **Get** /v2/Attempts | 
     9  
    10  
    11  
    12  ## FetchVerificationAttempt
    13  
    14  > VerifyV2VerificationAttempt FetchVerificationAttempt(ctx, Sid)
    15  
    16  
    17  
    18  Fetch a specific verification attempt.
    19  
    20  ### Path Parameters
    21  
    22  
    23  Name | Type | Description
    24  ------------- | ------------- | -------------
    25  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    26  **Sid** | **string** | The unique SID identifier of a Verification Attempt
    27  
    28  ### Other Parameters
    29  
    30  Other parameters are passed through a pointer to a FetchVerificationAttemptParams struct
    31  
    32  
    33  Name | Type | Description
    34  ------------- | ------------- | -------------
    35  
    36  ### Return type
    37  
    38  [**VerifyV2VerificationAttempt**](VerifyV2VerificationAttempt.md)
    39  
    40  ### Authorization
    41  
    42  [accountSid_authToken](../README.md#accountSid_authToken)
    43  
    44  ### HTTP request headers
    45  
    46  - **Content-Type**: Not defined
    47  - **Accept**: application/json
    48  
    49  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    50  [[Back to Model list]](../README.md#documentation-for-models)
    51  [[Back to README]](../README.md)
    52  
    53  
    54  ## ListVerificationAttempt
    55  
    56  > []VerifyV2VerificationAttempt ListVerificationAttempt(ctx, optional)
    57  
    58  
    59  
    60  List all the verification attempts for a given Account.
    61  
    62  ### Path Parameters
    63  
    64  This endpoint does not need any path parameter.
    65  
    66  ### Other Parameters
    67  
    68  Other parameters are passed through a pointer to a ListVerificationAttemptParams struct
    69  
    70  
    71  Name | Type | Description
    72  ------------- | ------------- | -------------
    73  **DateCreatedAfter** | **time.Time** | Datetime filter used to consider only Verification Attempts created after this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd'T'HH:mm:ss'Z.
    74  **DateCreatedBefore** | **time.Time** | Datetime filter used to consider only Verification Attempts created before this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd'T'HH:mm:ss'Z.
    75  **ChannelDataTo** | **string** | Destination of a verification. It is phone number in E.164 format.
    76  **Country** | **string** | Filter used to query Verification Attempts sent to the specified destination country.
    77  **Channel** | **string** | Filter used to query Verification Attempts by communication channel. Valid values are `SMS` and `CALL`
    78  **VerifyServiceSid** | **string** | Filter used to query Verification Attempts by verify service. Only attempts of the provided SID will be returned.
    79  **VerificationSid** | **string** | Filter used to return all the Verification Attempts of a single verification. Only attempts of the provided verification SID will be returned.
    80  **Status** | **string** | Filter used to query Verification Attempts by conversion status. Valid values are `UNCONVERTED`, for attempts that were not converted, and `CONVERTED`, for attempts that were confirmed.
    81  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
    82  **Limit** | **int** | Max number of records to return.
    83  
    84  ### Return type
    85  
    86  [**[]VerifyV2VerificationAttempt**](VerifyV2VerificationAttempt.md)
    87  
    88  ### Authorization
    89  
    90  [accountSid_authToken](../README.md#accountSid_authToken)
    91  
    92  ### HTTP request headers
    93  
    94  - **Content-Type**: Not defined
    95  - **Accept**: application/json
    96  
    97  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    98  [[Back to Model list]](../README.md#documentation-for-models)
    99  [[Back to README]](../README.md)
   100