github.com/twilio/twilio-go@v1.20.1/rest/api/v2010/docs/AccountsSIPCredentialListsCredentialsApi.md (about) 1 # AccountsSIPCredentialListsCredentialsApi 2 3 All URIs are relative to *https://api.twilio.com* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**CreateSipCredential**](AccountsSIPCredentialListsCredentialsApi.md#CreateSipCredential) | **Post** /2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{CredentialListSid}/Credentials.json | 8 [**DeleteSipCredential**](AccountsSIPCredentialListsCredentialsApi.md#DeleteSipCredential) | **Delete** /2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{CredentialListSid}/Credentials/{Sid}.json | 9 [**FetchSipCredential**](AccountsSIPCredentialListsCredentialsApi.md#FetchSipCredential) | **Get** /2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{CredentialListSid}/Credentials/{Sid}.json | 10 [**ListSipCredential**](AccountsSIPCredentialListsCredentialsApi.md#ListSipCredential) | **Get** /2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{CredentialListSid}/Credentials.json | 11 [**UpdateSipCredential**](AccountsSIPCredentialListsCredentialsApi.md#UpdateSipCredential) | **Post** /2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{CredentialListSid}/Credentials/{Sid}.json | 12 13 14 15 ## CreateSipCredential 16 17 > ApiV2010SipCredential CreateSipCredential(ctx, CredentialListSidoptional) 18 19 20 21 Create a new credential resource. 22 23 ### Path Parameters 24 25 26 Name | Type | Description 27 ------------- | ------------- | ------------- 28 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 29 **CredentialListSid** | **string** | The unique id that identifies the credential list to include the created credential. 30 31 ### Other Parameters 32 33 Other parameters are passed through a pointer to a CreateSipCredentialParams struct 34 35 36 Name | Type | Description 37 ------------- | ------------- | ------------- 38 **PathAccountSid** | **string** | The unique id of the Account that is responsible for this resource. 39 **Username** | **string** | The username that will be passed when authenticating SIP requests. The username should be sent in response to Twilio's challenge of the initial INVITE. It can be up to 32 characters long. 40 **Password** | **string** | The password that the username will use when authenticating SIP requests. The password must be a minimum of 12 characters, contain at least 1 digit, and have mixed case. (eg `IWasAtSignal2018`) 41 42 ### Return type 43 44 [**ApiV2010SipCredential**](ApiV2010SipCredential.md) 45 46 ### Authorization 47 48 [accountSid_authToken](../README.md#accountSid_authToken) 49 50 ### HTTP request headers 51 52 - **Content-Type**: application/x-www-form-urlencoded 53 - **Accept**: application/json 54 55 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 56 [[Back to Model list]](../README.md#documentation-for-models) 57 [[Back to README]](../README.md) 58 59 60 ## DeleteSipCredential 61 62 > DeleteSipCredential(ctx, CredentialListSidSidoptional) 63 64 65 66 Delete a credential resource. 67 68 ### Path Parameters 69 70 71 Name | Type | Description 72 ------------- | ------------- | ------------- 73 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 74 **CredentialListSid** | **string** | The unique id that identifies the credential list that contains the desired credentials. 75 **Sid** | **string** | The unique id that identifies the resource to delete. 76 77 ### Other Parameters 78 79 Other parameters are passed through a pointer to a DeleteSipCredentialParams struct 80 81 82 Name | Type | Description 83 ------------- | ------------- | ------------- 84 **PathAccountSid** | **string** | The unique id of the Account that is responsible for this resource. 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 ## FetchSipCredential 105 106 > ApiV2010SipCredential FetchSipCredential(ctx, CredentialListSidSidoptional) 107 108 109 110 Fetch a single credential. 111 112 ### Path Parameters 113 114 115 Name | Type | Description 116 ------------- | ------------- | ------------- 117 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 118 **CredentialListSid** | **string** | The unique id that identifies the credential list that contains the desired credential. 119 **Sid** | **string** | The unique id that identifies the resource to fetch. 120 121 ### Other Parameters 122 123 Other parameters are passed through a pointer to a FetchSipCredentialParams struct 124 125 126 Name | Type | Description 127 ------------- | ------------- | ------------- 128 **PathAccountSid** | **string** | The unique id of the Account that is responsible for this resource. 129 130 ### Return type 131 132 [**ApiV2010SipCredential**](ApiV2010SipCredential.md) 133 134 ### Authorization 135 136 [accountSid_authToken](../README.md#accountSid_authToken) 137 138 ### HTTP request headers 139 140 - **Content-Type**: Not defined 141 - **Accept**: application/json 142 143 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 144 [[Back to Model list]](../README.md#documentation-for-models) 145 [[Back to README]](../README.md) 146 147 148 ## ListSipCredential 149 150 > []ApiV2010SipCredential ListSipCredential(ctx, CredentialListSidoptional) 151 152 153 154 Retrieve a list of credentials. 155 156 ### Path Parameters 157 158 159 Name | Type | Description 160 ------------- | ------------- | ------------- 161 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 162 **CredentialListSid** | **string** | The unique id that identifies the credential list that contains the desired credentials. 163 164 ### Other Parameters 165 166 Other parameters are passed through a pointer to a ListSipCredentialParams struct 167 168 169 Name | Type | Description 170 ------------- | ------------- | ------------- 171 **PathAccountSid** | **string** | The unique id of the Account that is responsible for this resource. 172 **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000. 173 **Limit** | **int** | Max number of records to return. 174 175 ### Return type 176 177 [**[]ApiV2010SipCredential**](ApiV2010SipCredential.md) 178 179 ### Authorization 180 181 [accountSid_authToken](../README.md#accountSid_authToken) 182 183 ### HTTP request headers 184 185 - **Content-Type**: Not defined 186 - **Accept**: application/json 187 188 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 189 [[Back to Model list]](../README.md#documentation-for-models) 190 [[Back to README]](../README.md) 191 192 193 ## UpdateSipCredential 194 195 > ApiV2010SipCredential UpdateSipCredential(ctx, CredentialListSidSidoptional) 196 197 198 199 Update a credential resource. 200 201 ### Path Parameters 202 203 204 Name | Type | Description 205 ------------- | ------------- | ------------- 206 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 207 **CredentialListSid** | **string** | The unique id that identifies the credential list that includes this credential. 208 **Sid** | **string** | The unique id that identifies the resource to update. 209 210 ### Other Parameters 211 212 Other parameters are passed through a pointer to a UpdateSipCredentialParams struct 213 214 215 Name | Type | Description 216 ------------- | ------------- | ------------- 217 **PathAccountSid** | **string** | The unique id of the Account that is responsible for this resource. 218 **Password** | **string** | The password that the username will use when authenticating SIP requests. The password must be a minimum of 12 characters, contain at least 1 digit, and have mixed case. (eg `IWasAtSignal2018`) 219 220 ### Return type 221 222 [**ApiV2010SipCredential**](ApiV2010SipCredential.md) 223 224 ### Authorization 225 226 [accountSid_authToken](../README.md#accountSid_authToken) 227 228 ### HTTP request headers 229 230 - **Content-Type**: application/x-www-form-urlencoded 231 - **Accept**: application/json 232 233 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 234 [[Back to Model list]](../README.md#documentation-for-models) 235 [[Back to README]](../README.md) 236