Register Tester

The Register Tester API is used to register a mobile number as a test device under a specific agent and brand. This enables simulation and validation of RCS messaging flows in a test environment. It helps developers and QA teams ensure message delivery and formatting before going live.

Prerequisites

After you sign up, your account will be on the trial version. You must complete the KYC to access all the features in kaleyra.io.
Before you get started, Create an API Key. To view the API Key and the SID, see View API Key and SID.
Before sending the RCS, you must configure the RCS channel in the Kaleyra platform. To configure the RCS channel in your account, please contact your local Kaleyra representative.

Base URL

URL	Region
`https://rcs-api.<pod>.kaleyra.io`	For North America (NA).
`https://rcs-api.<pod>.kaleyra.io`	For the rest of the world.

API Domain and Value

api_domain	Value
IN pod	`https://rcs-api.in.kaleyra.io`
NA pod	`https://rcs-api.na.kaleyra.io`

API request to Register a Tester

To register a tester, use the https://rcs-api.<pod>.kaleyra.io/v1/<sid>/rcs/agent/registerTester endpoint with the following request method:

Request Format

The following is the request format to register a tester:

curl --location 'https://<api_domain>/v1/<sid>/rcs/messages\
--header 'Content-Type:<Content-Type>' \
--header 'api-key: <api-key>' \
--data {  
    "phoneno":"<phone number>",  
    "agent_no":"<agent number>"  
}

Sample Request Format

The following is the sample request format to register a tester:

curl --location ' 
‘https://rcs-api.na.kaleyra.io/v1/xxxxx6913850xxxx/rcs/agent/registerTester' \ 
--header 'Content-Type: application/json' \  
--header 'api-key: xxxxx3b8497f58a94e84b671aca43xxxx' \  
--data '{  
    "phoneno":"91953XXXXX92",  
    "agent_no":"48900"  
}'

URL Parameters and Headers

The following is the list of parameters and headers to send the outgoing message request:

Parameter/Headers	Data Type	Description	Example	Mandatory?
`sid`	String	Account SID (Security Identifier).	XXXXX6913850XXXX	Yes
`Content-Type`	String	Indicates the format of the content the API will be processing.	The only allowed value is application/JSON	Yes
`api-key`	String	API key generated from kaleyra.io account.	XXXXX3b8497f58a94e84b671aca43XXXX	Yes

Following is the list of attributes to be used in the payload to send the messages:

Parameter	Data Type	Description	Example	Mandatory?
`phoneno`	String	Mobile number to be registered as a tester (E.164 format without +).	91953XXXXX92	Yes
`agent_no`	String	Service code unique to the agent specified when the agent is created/onboarded.	48900	Yes

Sample Success Response

The following success message:

{
"phoneno": "91953XXXXX92",
"agent_no": "48900",
"id": "e1b9479c-3fe5-43d5-9dde-2d487b9baf1b"
}