This is only used through the AWS console during sign-up to associate your WhatsApp Business Account to your AWS account.
Request Syntax
POST /v1/whatsapp/signup HTTP/1.1
Content-type: application/json
{
"setupFinalization": {
"associateInProgressToken": "string",
"phoneNumberParent": "string",
"phoneNumbers": [
{
"dataLocalizationRegion": "string",
"id": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"twoFactorPin": "string"
}
],
"waba": {
"eventDestinations": [
{
"eventDestinationArn": "string",
"roleArn": "string"
}
],
"id": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
},
"signupCallback": {
"accessToken": "string"
}
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- setupFinalization
-
A JSON object that contains the phone numbers and WhatsApp Business Account to link to your account.
Type: WhatsAppSetupFinalization object
Required: No
- signupCallback
-
Contains the callback access token.
Type: WhatsAppSignupCallback object
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"signupCallbackResult": {
"associateInProgressToken": "string",
"linkedAccountsWithIncompleteSetup": {
"string" : {
"accountName": "string",
"registrationStatus": "string",
"unregisteredWhatsAppPhoneNumbers": [
{
"arn": "string",
"displayPhoneNumber": "string",
"displayPhoneNumberName": "string",
"metaPhoneNumberId": "string",
"phoneNumber": "string",
"phoneNumberId": "string",
"qualityRating": "string"
}
],
"wabaId": "string"
}
}
},
"statusCode": number
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- signupCallbackResult
-
Contains your WhatsApp registration status.
Type: WhatsAppSignupCallbackResult object
- statusCode
-
The status code for the response.
Type: Integer
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- DependencyException
-
Thrown when performing an action because a dependency would be broken.
HTTP Status Code: 502
- InvalidParametersException
-
One or more parameters provided to the action are not valid.
HTTP Status Code: 400
- ThrottledRequestException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The request contains an invalid parameter value.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
