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

     1  # HostedNumberAuthorizationDocumentsApi
     2  
     3  All URIs are relative to *https://numbers.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateAuthorizationDocument**](HostedNumberAuthorizationDocumentsApi.md#CreateAuthorizationDocument) | **Post** /v2/HostedNumber/AuthorizationDocuments | 
     8  [**DeleteAuthorizationDocument**](HostedNumberAuthorizationDocumentsApi.md#DeleteAuthorizationDocument) | **Delete** /v2/HostedNumber/AuthorizationDocuments/{Sid} | 
     9  [**FetchAuthorizationDocument**](HostedNumberAuthorizationDocumentsApi.md#FetchAuthorizationDocument) | **Get** /v2/HostedNumber/AuthorizationDocuments/{Sid} | 
    10  [**ListAuthorizationDocument**](HostedNumberAuthorizationDocumentsApi.md#ListAuthorizationDocument) | **Get** /v2/HostedNumber/AuthorizationDocuments | 
    11  
    12  
    13  
    14  ## CreateAuthorizationDocument
    15  
    16  > NumbersV2AuthorizationDocument CreateAuthorizationDocument(ctx, optional)
    17  
    18  
    19  
    20  Create an AuthorizationDocument for authorizing the hosting of phone number capabilities on Twilio's platform.
    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 CreateAuthorizationDocumentParams struct
    29  
    30  
    31  Name | Type | Description
    32  ------------- | ------------- | -------------
    33  **AddressSid** | **string** | A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument.
    34  **Email** | **string** | Email that this AuthorizationDocument will be sent to for signing.
    35  **ContactPhoneNumber** | **string** | The contact phone number of the person authorized to sign the Authorization Document.
    36  **HostedNumberOrderSids** | **[]string** | A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform.
    37  **ContactTitle** | **string** | The title of the person authorized to sign the Authorization Document for this phone number.
    38  **CcEmails** | **[]string** | Email recipients who will be informed when an Authorization Document has been sent and signed.
    39  
    40  ### Return type
    41  
    42  [**NumbersV2AuthorizationDocument**](NumbersV2AuthorizationDocument.md)
    43  
    44  ### Authorization
    45  
    46  [accountSid_authToken](../README.md#accountSid_authToken)
    47  
    48  ### HTTP request headers
    49  
    50  - **Content-Type**: application/x-www-form-urlencoded
    51  - **Accept**: application/json
    52  
    53  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    54  [[Back to Model list]](../README.md#documentation-for-models)
    55  [[Back to README]](../README.md)
    56  
    57  
    58  ## DeleteAuthorizationDocument
    59  
    60  > DeleteAuthorizationDocument(ctx, Sid)
    61  
    62  
    63  
    64  Cancel the AuthorizationDocument request.
    65  
    66  ### Path Parameters
    67  
    68  
    69  Name | Type | Description
    70  ------------- | ------------- | -------------
    71  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    72  **Sid** | **string** | A 34 character string that uniquely identifies this AuthorizationDocument.
    73  
    74  ### Other Parameters
    75  
    76  Other parameters are passed through a pointer to a DeleteAuthorizationDocumentParams struct
    77  
    78  
    79  Name | Type | Description
    80  ------------- | ------------- | -------------
    81  
    82  ### Return type
    83  
    84   (empty response body)
    85  
    86  ### Authorization
    87  
    88  [accountSid_authToken](../README.md#accountSid_authToken)
    89  
    90  ### HTTP request headers
    91  
    92  - **Content-Type**: Not defined
    93  - **Accept**: Not defined
    94  
    95  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    96  [[Back to Model list]](../README.md#documentation-for-models)
    97  [[Back to README]](../README.md)
    98  
    99  
   100  ## FetchAuthorizationDocument
   101  
   102  > NumbersV2AuthorizationDocument FetchAuthorizationDocument(ctx, Sid)
   103  
   104  
   105  
   106  Fetch a specific AuthorizationDocument.
   107  
   108  ### Path Parameters
   109  
   110  
   111  Name | Type | Description
   112  ------------- | ------------- | -------------
   113  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   114  **Sid** | **string** | A 34 character string that uniquely identifies this AuthorizationDocument.
   115  
   116  ### Other Parameters
   117  
   118  Other parameters are passed through a pointer to a FetchAuthorizationDocumentParams struct
   119  
   120  
   121  Name | Type | Description
   122  ------------- | ------------- | -------------
   123  
   124  ### Return type
   125  
   126  [**NumbersV2AuthorizationDocument**](NumbersV2AuthorizationDocument.md)
   127  
   128  ### Authorization
   129  
   130  [accountSid_authToken](../README.md#accountSid_authToken)
   131  
   132  ### HTTP request headers
   133  
   134  - **Content-Type**: Not defined
   135  - **Accept**: application/json
   136  
   137  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   138  [[Back to Model list]](../README.md#documentation-for-models)
   139  [[Back to README]](../README.md)
   140  
   141  
   142  ## ListAuthorizationDocument
   143  
   144  > []NumbersV2AuthorizationDocument ListAuthorizationDocument(ctx, optional)
   145  
   146  
   147  
   148  Retrieve a list of AuthorizationDocuments belonging to the account initiating the request.
   149  
   150  ### Path Parameters
   151  
   152  This endpoint does not need any path parameter.
   153  
   154  ### Other Parameters
   155  
   156  Other parameters are passed through a pointer to a ListAuthorizationDocumentParams struct
   157  
   158  
   159  Name | Type | Description
   160  ------------- | ------------- | -------------
   161  **Email** | **string** | Email that this AuthorizationDocument will be sent to for signing.
   162  **Status** | **string** | Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses.
   163  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   164  **Limit** | **int** | Max number of records to return.
   165  
   166  ### Return type
   167  
   168  [**[]NumbersV2AuthorizationDocument**](NumbersV2AuthorizationDocument.md)
   169  
   170  ### Authorization
   171  
   172  [accountSid_authToken](../README.md#accountSid_authToken)
   173  
   174  ### HTTP request headers
   175  
   176  - **Content-Type**: Not defined
   177  - **Accept**: application/json
   178  
   179  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   180  [[Back to Model list]](../README.md#documentation-for-models)
   181  [[Back to README]](../README.md)
   182