github.com/twilio/twilio-go@v1.20.1/rest/messaging/v1/docs/ServicesComplianceUsa2pApi.md (about) 1 # ServicesComplianceUsa2pApi 2 3 All URIs are relative to *https://messaging.twilio.com* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**CreateUsAppToPerson**](ServicesComplianceUsa2pApi.md#CreateUsAppToPerson) | **Post** /v1/Services/{MessagingServiceSid}/Compliance/Usa2p | 8 [**DeleteUsAppToPerson**](ServicesComplianceUsa2pApi.md#DeleteUsAppToPerson) | **Delete** /v1/Services/{MessagingServiceSid}/Compliance/Usa2p/{Sid} | 9 [**FetchUsAppToPerson**](ServicesComplianceUsa2pApi.md#FetchUsAppToPerson) | **Get** /v1/Services/{MessagingServiceSid}/Compliance/Usa2p/{Sid} | 10 [**ListUsAppToPerson**](ServicesComplianceUsa2pApi.md#ListUsAppToPerson) | **Get** /v1/Services/{MessagingServiceSid}/Compliance/Usa2p | 11 [**UpdateUsAppToPerson**](ServicesComplianceUsa2pApi.md#UpdateUsAppToPerson) | **Post** /v1/Services/{MessagingServiceSid}/Compliance/Usa2p/{Sid} | 12 13 14 15 ## CreateUsAppToPerson 16 17 > MessagingV1UsAppToPerson CreateUsAppToPerson(ctx, MessagingServiceSidoptional) 18 19 20 21 22 23 ### Path Parameters 24 25 26 Name | Type | Description 27 ------------- | ------------- | ------------- 28 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 29 **MessagingServiceSid** | **string** | The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to create the resources from. 30 31 ### Other Parameters 32 33 Other parameters are passed through a pointer to a CreateUsAppToPersonParams struct 34 35 36 Name | Type | Description 37 ------------- | ------------- | ------------- 38 **BrandRegistrationSid** | **string** | A2P Brand Registration SID 39 **Description** | **string** | A short description of what this SMS campaign does. Min length: 40 characters. Max length: 4096 characters. 40 **MessageFlow** | **string** | Required for all Campaigns. Details around how a consumer opts-in to their campaign, therefore giving consent to receive their messages. If multiple opt-in methods can be used for the same campaign, they must all be listed. 40 character minimum. 2048 character maximum. 41 **MessageSamples** | **[]string** | An array of sample message strings, min two and max five. Min length for each sample: 20 chars. Max length for each sample: 1024 chars. 42 **UsAppToPersonUsecase** | **string** | A2P Campaign Use Case. Examples: [ 2FA, EMERGENCY, MARKETING..] 43 **HasEmbeddedLinks** | **bool** | Indicates that this SMS campaign will send messages that contain links. 44 **HasEmbeddedPhone** | **bool** | Indicates that this SMS campaign will send messages that contain phone numbers. 45 **OptInMessage** | **string** | If end users can text in a keyword to start receiving messages from this campaign, the auto-reply messages sent to the end users must be provided. The opt-in response should include the Brand name, confirmation of opt-in enrollment to a recurring message campaign, how to get help, and clear description of how to opt-out. This field is required if end users can text in a keyword to start receiving messages from this campaign. 20 character minimum. 320 character maximum. 46 **OptOutMessage** | **string** | Upon receiving the opt-out keywords from the end users, Twilio customers are expected to send back an auto-generated response, which must provide acknowledgment of the opt-out request and confirmation that no further messages will be sent. It is also recommended that these opt-out messages include the brand name. This field is required if managing opt out keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). 20 character minimum. 320 character maximum. 47 **HelpMessage** | **string** | When customers receive the help keywords from their end users, Twilio customers are expected to send back an auto-generated response; this may include the brand name and additional support contact information. This field is required if managing help keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). 20 character minimum. 320 character maximum. 48 **OptInKeywords** | **[]string** | If end users can text in a keyword to start receiving messages from this campaign, those keywords must be provided. This field is required if end users can text in a keyword to start receiving messages from this campaign. Values must be alphanumeric. 255 character maximum. 49 **OptOutKeywords** | **[]string** | End users should be able to text in a keyword to stop receiving messages from this campaign. Those keywords must be provided. This field is required if managing opt out keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). Values must be alphanumeric. 255 character maximum. 50 **HelpKeywords** | **[]string** | End users should be able to text in a keyword to receive help. Those keywords must be provided as part of the campaign registration request. This field is required if managing help keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). Values must be alphanumeric. 255 character maximum. 51 **SubscriberOptIn** | **bool** | A boolean that specifies whether campaign has Subscriber Optin or not. 52 **AgeGated** | **bool** | A boolean that specifies whether campaign is age gated or not. 53 **DirectLending** | **bool** | A boolean that specifies whether campaign allows direct lending or not. 54 55 ### Return type 56 57 [**MessagingV1UsAppToPerson**](MessagingV1UsAppToPerson.md) 58 59 ### Authorization 60 61 [accountSid_authToken](../README.md#accountSid_authToken) 62 63 ### HTTP request headers 64 65 - **Content-Type**: application/x-www-form-urlencoded 66 - **Accept**: application/json 67 68 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 69 [[Back to Model list]](../README.md#documentation-for-models) 70 [[Back to README]](../README.md) 71 72 73 ## DeleteUsAppToPerson 74 75 > DeleteUsAppToPerson(ctx, MessagingServiceSidSid) 76 77 78 79 80 81 ### Path Parameters 82 83 84 Name | Type | Description 85 ------------- | ------------- | ------------- 86 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 87 **MessagingServiceSid** | **string** | The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to delete the resource from. 88 **Sid** | **string** | The SID of the US A2P Compliance resource to delete `QE2c6890da8086d771620e9b13fadeba0b`. 89 90 ### Other Parameters 91 92 Other parameters are passed through a pointer to a DeleteUsAppToPersonParams struct 93 94 95 Name | Type | Description 96 ------------- | ------------- | ------------- 97 98 ### Return type 99 100 (empty response body) 101 102 ### Authorization 103 104 [accountSid_authToken](../README.md#accountSid_authToken) 105 106 ### HTTP request headers 107 108 - **Content-Type**: Not defined 109 - **Accept**: Not defined 110 111 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 112 [[Back to Model list]](../README.md#documentation-for-models) 113 [[Back to README]](../README.md) 114 115 116 ## FetchUsAppToPerson 117 118 > MessagingV1UsAppToPerson FetchUsAppToPerson(ctx, MessagingServiceSidSid) 119 120 121 122 123 124 ### Path Parameters 125 126 127 Name | Type | Description 128 ------------- | ------------- | ------------- 129 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 130 **MessagingServiceSid** | **string** | The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to fetch the resource from. 131 **Sid** | **string** | The SID of the US A2P Compliance resource to fetch `QE2c6890da8086d771620e9b13fadeba0b`. 132 133 ### Other Parameters 134 135 Other parameters are passed through a pointer to a FetchUsAppToPersonParams struct 136 137 138 Name | Type | Description 139 ------------- | ------------- | ------------- 140 141 ### Return type 142 143 [**MessagingV1UsAppToPerson**](MessagingV1UsAppToPerson.md) 144 145 ### Authorization 146 147 [accountSid_authToken](../README.md#accountSid_authToken) 148 149 ### HTTP request headers 150 151 - **Content-Type**: Not defined 152 - **Accept**: application/json 153 154 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 155 [[Back to Model list]](../README.md#documentation-for-models) 156 [[Back to README]](../README.md) 157 158 159 ## ListUsAppToPerson 160 161 > []MessagingV1UsAppToPerson ListUsAppToPerson(ctx, MessagingServiceSidoptional) 162 163 164 165 166 167 ### Path Parameters 168 169 170 Name | Type | Description 171 ------------- | ------------- | ------------- 172 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 173 **MessagingServiceSid** | **string** | The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to fetch the resource from. 174 175 ### Other Parameters 176 177 Other parameters are passed through a pointer to a ListUsAppToPersonParams struct 178 179 180 Name | Type | Description 181 ------------- | ------------- | ------------- 182 **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000. 183 **Limit** | **int** | Max number of records to return. 184 185 ### Return type 186 187 [**[]MessagingV1UsAppToPerson**](MessagingV1UsAppToPerson.md) 188 189 ### Authorization 190 191 [accountSid_authToken](../README.md#accountSid_authToken) 192 193 ### HTTP request headers 194 195 - **Content-Type**: Not defined 196 - **Accept**: application/json 197 198 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 199 [[Back to Model list]](../README.md#documentation-for-models) 200 [[Back to README]](../README.md) 201 202 203 ## UpdateUsAppToPerson 204 205 > MessagingV1UsAppToPerson UpdateUsAppToPerson(ctx, MessagingServiceSidSidoptional) 206 207 208 209 210 211 ### Path Parameters 212 213 214 Name | Type | Description 215 ------------- | ------------- | ------------- 216 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 217 **MessagingServiceSid** | **string** | The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) to update the resource from. 218 **Sid** | **string** | The SID of the US A2P Compliance resource to update `QE2c6890da8086d771620e9b13fadeba0b`. 219 220 ### Other Parameters 221 222 Other parameters are passed through a pointer to a UpdateUsAppToPersonParams struct 223 224 225 Name | Type | Description 226 ------------- | ------------- | ------------- 227 **HasEmbeddedLinks** | **bool** | Indicates that this SMS campaign will send messages that contain links. 228 **HasEmbeddedPhone** | **bool** | Indicates that this SMS campaign will send messages that contain phone numbers. 229 **MessageSamples** | **[]string** | An array of sample message strings, min two and max five. Min length for each sample: 20 chars. Max length for each sample: 1024 chars. 230 **MessageFlow** | **string** | Required for all Campaigns. Details around how a consumer opts-in to their campaign, therefore giving consent to receive their messages. If multiple opt-in methods can be used for the same campaign, they must all be listed. 40 character minimum. 2048 character maximum. 231 **Description** | **string** | A short description of what this SMS campaign does. Min length: 40 characters. Max length: 4096 characters. 232 **AgeGated** | **bool** | A boolean that specifies whether campaign requires age gate for federally legal content. 233 **DirectLending** | **bool** | A boolean that specifies whether campaign allows direct lending or not. 234 235 ### Return type 236 237 [**MessagingV1UsAppToPerson**](MessagingV1UsAppToPerson.md) 238 239 ### Authorization 240 241 [accountSid_authToken](../README.md#accountSid_authToken) 242 243 ### HTTP request headers 244 245 - **Content-Type**: application/x-www-form-urlencoded 246 - **Accept**: application/json 247 248 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 249 [[Back to Model list]](../README.md#documentation-for-models) 250 [[Back to README]](../README.md) 251