Method: phones.testers.create

  • Users can be invited to test an agent, but they must be RCS-enabled and reachable by the RBM platform, and they must also confirm their desire to be a tester.

  • Unlaunched agents can only interact with users who have been confirmed as testers, otherwise a 403 PERMISSION_DENIED error will occur.

  • An agent is restricted to sending only 20 tester requests per day, with a maximum of 200 tester requests total, exceeding these limits results in a 429 RESOURCE_EXHAUSTED error.

  • The URL endpoint for sending a request to invite a tester follows the format POST https://rcsbusinessmessaging.googleapis.com/v1/{parent=phones/*}/testers where the phone number of the user must be in E.164 format.

  • An agent's unique identifier is required in the request as the agentId query parameter.

Invites a user to test an agent.

The invited user must be RCS-enabled and reachable by the RBM platform. When an agent invites a user to become a tester, an RBM platform management agent sends a message to the user asking for confirmation that she wants to be a tester of the agent. Once the user confirms, she becomes a tester.

An agent that has not yet launched can only interact with users who are testers of that agent. If an unlaunched agent attempts to send a message, event, or capability callback to a non-tester, the RBM platform returns a 403 PERMISSION_DENIED error.

An agent can send 20 tester requests each day with a total maximum of 200 tester requests. If you send tester requests above those limits, the RBM platform returns a 429 RESOURCE_EXHAUSTED response.

HTTP request

POST https://rcsbusinessmessaging.googleapis.com/v1/{parent=phones/*}/testers

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

"phones/{E.164}", where {E.164} is the user's phone number in E.164 format. For example, with the US phone number +1-222-333-4444, the resulting endpoint would be https://rcsbusinessmessaging.googleapis.com/v1/phones/+12223334444/testers/.

Query parameters

Parameters
agentId

string

Required. The agent's unique identifier.

Request body

The request body contains an instance of Tester.

Response body

If successful, the response body contains a newly created instance of Tester.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/rcsbusinessmessaging

For more information, see the OAuth 2.0 Overview.