Beta Tester Management REST API Reference
After you set up a beta test for your Alexa skill, use the Beta Tester Management REST API to invite friends or family, your social network contacts, or other people for whom you have an email address to test your skill. At any time, you can add testers, remove testers, or end a test.
For more details about how to set up a beta test, see Beta Test Management REST API Reference.
Authentication
Each API request must have an authorization header whose value is the access token retrieved from Login with Amazon (LWA). For details, see Get an Access Token for SMAPI.
Operations
The Beta Tester Management API includes the following operations.
| Operation | HTTP method and URI |
|---|---|
|
| |
|
| |
|
|
Add beta testers
Add testers to an existing beta test. You can add up to 500 testers.
On success, the tester receives an email with a customized link inviting them to be beta testers for your skill. Amazon controls the messaging for this invitation.
Request
To add testers, you make a POST request to the betaTest/testers resource.
Request path and header example
POST /v1/skills/{skillId}/betaTest/testers/add
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Request path and header parameters
| Parameter | Located in | Description | Type | Required |
|---|---|---|---|---|
|
|
Path |
Identifies the skill. |
String |
Yes |
|
|
Header |
String |
Yes |
Request body example
{
"testers": [{
"emailId": "example@email.address"
}]
}
Request body properties
| Property | Description | Type | Required |
|---|---|---|---|
|
|
List of testers to add. |
Array of objects |
Yes |
|
|
Email address of the tester. |
String |
Yes |
Response
A successful response returns HTTP 204 No Content.
On error, the response returns the appropriate HTTP status code and includes a response body with an error code and human readable message.
Response body example
The response has no body.
Response body properties
The response has no body.
HTTP status codes
| Status | Description |
|---|---|
|
|
Request to add a beta tester succeeded. |
|
|
Indicates that one or more properties in the request body aren't valid. |
|
|
Request didn't include the authorization token, or the included token expired or isn't valid. Or, you don't have access to the resource. |
|
|
Indicates that the authorization token is valid, but the requested operation isn't allowed. |
|
|
Requested resource not found. |
|
|
Permitted rate limit, specified as number of requests per unit of time, exceeded. Retry the request by using exponential back-off. |
|
|
Error occurred on the server. Retry the request by using exponential back-off. |
|
|
Server is down for maintenance, overloaded, or otherwise unavailable to handle the incoming request. |
List beta testers
Get the list of testers in the beta test for the specified skill.
Request
To list testers, you make a GET request to the betaTest/testers resource.
Request path and header example
GET /v1/skills/{skillId}/betaTest/testers?maxResults={maxResults}&nextToken={nextToken}
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Accept: application/json
Request path and header parameters
| Parameter | Located in | Description | Type | Required |
|---|---|---|---|---|
|
|
Path |
Identifies the skill. |
String |
Yes |
|
|
Query |
Maximum number of results to return in the response. |
Integer |
No |
|
|
Query |
Token from the previous response. If not included, the Alexa service returns the first page of results. |
String |
No |
|
|
Header |
String |
Yes |
Request body example
The request has no body.
Request body properties
The request has no body.
Response
A successful response returns HTTP 200 OK, along with a list of testers.
On error, the response returns the appropriate HTTP status code and includes a response body with an error code and human readable message.
Response body example
{
"testers": [
{
"emailId": "example@email.address",
"associationDate": "2018-09-26T07:32:37.589Z",
"isReminderAllowed": true,
"invitationStatus": "ACCEPTED"
}
],
"isTruncated": true,
"nextToken": "someToken.1"
}
Response body properties
| Property | Description | Type |
|---|---|---|
|
|
List of testers. |
Array of objects |
|
|
Email address of the tester. |
String |
|
|
Date and time that the tester joined the beta test. |
String |
|
|
Indicates whether you can send the tester a reminder. |
Boolean |
|
|
Status of the invitation request. |
String |
|
|
Indicates whether there are more items to return. If set to |
Boolean |
|
|
(Optional) Included when there are more results to return. Use this value in a subsequent request. |
String |
HTTP status codes
| Status | Description |
|---|---|
|
|
Response body contains a list of testers. |
|
|
Indicates that one or more properties in the request body aren't valid. |
|
|
Request didn't include the authorization token, or the included token expired or isn't valid. Or, you don't have access to the resource. |
|
|
Indicates that the authorization token is valid, but the requested operation isn't allowed. |
|
|
Requested resource not found. |
|
|
Permitted rate limit, specified as number of requests per unit of time, exceeded. Retry the request by using exponential back-off. |
|
|
Error occurred on the server. Retry the request by using exponential back-off. |
|
|
Server is down for maintenance, overloaded, or otherwise unavailable to handle the incoming request. |
Remove testers
Remove testers from the beta test for the specified skill.
Request
To remove testers, you make a POST request to the betaTest/testers resource.
Request path and header example
POST /v1/skills/{skillId}/betaTest/testers/remove
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Request path and header parameters
| Parameter | Located in | Description | Type | Required |
|---|---|---|---|---|
|
|
Path |
Identifies the skill. |
String |
Yes |
|
|
Header |
String |
Yes |
Request body example
{
"testers": [{
"emailId": "example@email.address"
}]
}
Request body properties
| Property | Description | Type | Required |
|---|---|---|---|
|
|
List of testers to remove. |
Array of objects |
Yes |
|
|
Email address of the tester. |
String |
Yes |
Response
A successful response returns HTTP 204 No Content.
On error, the response returns the appropriate HTTP status code and includes a response body with an error code and human readable message.
Response body example
The response has no body.
Response body properties
The response has no body.
HTTP status codes
| Status | Description |
|---|---|
|
|
Request to remove testers succeeded. |
|
|
Indicates that one or more properties in the request body aren't valid. |
|
|
Request didn't include the authorization token, or the included token expired or isn't valid. Or, you don't have access to the resource. |
|
|
Indicates that the authorization token is valid, but the requested operation isn't allowed. |
|
|
Requested resource not found. |
|
|
Permitted rate limit, specified as number of requests per unit of time, exceeded. Retry the request by using exponential back-off. |
|
|
Error occurred on the server. Retry the request by using exponential back-off. |
|
|
Server is down for maintenance, overloaded, or otherwise unavailable to handle the incoming request. |
Related topics
Last updated: Aug 01, 2024