Get Tester By Agent

The Get Tester by Agent API retrieves a list of test devices registered under a specific agent. This is useful for monitoring and managing test users during RCS message validation and QA processes. The response includes device status, test status, and other metadata associated with each tester.

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

https://rcs-api.<pod>.kaleyra.ai - For North America (NA).

https://rcs-api.<pod>.kaleyra.io - For 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.ai

API request to Get Tester by Agent

To get the tester by agent, use the https://<api_domain>/wsgw/v1/agent/testersbyagent endpoint with the following request method: 

Request Format

The following is the request format to get the tester by agent:

curl --location --request POST 'https://<api_domain>/ v1/<sid>/rcs/agent/testersbyagent?agent_number=<agent_number>' \ 
--header 'Content-Type:<Content-Type>' \ 
--header 'api-key: <api-key>' \

Sample Request Format

The following is the sample request format to get the details of the tester by agent:

curl --location --request GET "https://rcs-api.na.kaleyra.ai/v1/xxxxx6913850xxxx/rcs/agent/testersbyagent?agent_number=48900'\ 
--header 'Content-Type: application/json' \  
--header 'api-key: xxxxx3b8497f58a94e84b671aca43xxxx' \

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

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

Parameter	Data Type	Description	Example	Mandatory?
`agent_number`	String	A service code that is unique to the agent, assigned when the agent is created or onboarded.	48900	Yes

Sample Success Response

The following is the sample success response:

[  
    {  
       "phoneno": "91077XXXXXX79",
        "test_status": "",
        "status": "ACTIVE",
        "agent_no": "1102",
        "id": "9ded792d-e45e-436c-b313-7f68XXXXXXe85",
        "override_dcs_check": true,
        "carrierid": 0 
    }  
]