Get all Agents Detail

GET Method

The Get all Agents DetailAPI allows you to fetch the details of all the agents that belongs to the particular account.

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.
To send any RCS messages, 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.io/v1/<sid>

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 Get all Agents Detail

To get all agents detail, use the https://rcs-api.<pod>.kaleyra.io/v1/<sid>/rcs/agents endpoint with the following request method:

Request Format

The following is the request format to get all agents detail:

curl --location --request GET 'https://<api_domain>/v1/<sid>/rcs/agents'\
--header 'api-key: <api-key>' \ 
--header 'Content-Type: <content_type>' \

Sample Request Format

The following is the sample request format to get all agents detail:

curl --location --request GET 'https://rcs-api.na.kaleyra.io/v1/XXXXX6913850XXXX/rcs/agents'\
--header 'api-key: XXXXX3b8497f58a94e84b671aca43XXXX' \ 
--header 'Content-Type: application/json' \

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

Sample Success Response

The following is the sample success response:

{
    "code": "RCS902",
    "message": "RCS Agent details fetched successfully",
    "data": [
        {
            "id": "fb4a761b-50fe-4b3b-a29e-19XXXX02ead5",
            "agent_number": "74532",
            "service_code": "RCS-Bigbasket1",
            "status": "ACTIVE",
            "created_date": Jul 25,2025,3:19:01PM,
            "display_name": "Bigbasket_Agent_01",
            "brand_name": "RCS_Bigbasket",
            "agent_logo": "https://d2lu0ihi6f347r.cloudfront.net/1752XXXX77913-TC_Small_logo_(224_x_224)_1.png",
            "agent_use_case": "MULTI_USE",
            "agent_description": "UltraVision"
        },
        {
            "id": "bb1e82ef-d11c-476a-afb4-53XXXXXXXXeb",
            "agent_number": "74032",
            "service_code": "RCS-Bigbasket2",
            "status": "ACTIVE",
            "created_date": Jul 25,2025,3:19:01PM,
            "display_name": "Bigbasket_Agent_02",
            "brand_name": "RCS_Bigbasket",
            "agent_logo": "https://d2lu0ihi6f347r.cloudfront.net/1752750287913-TC_Small_logo_(224_x_224)_1.png",
            "agent_use_case": "MULTI_USE",
            "agent_description": "UltraVisionNextGenSmartCommercePlatform"
        },
        {
            "id": "f1e39800-ae45-4b45-87be-4d1f6XXXXX03",
            "agent_number": "66832",
            "service_code": "RCS-Bigbasket3",
            "status": "ACTIVE",
            "created_date": Jul 25,2025,3:19:01PM,
            "display_name": "Bigbasket_Agent_03",
            "brand_name": "RCS_Bigbasket",
            "agent_logo": "https://d2lu0ihi6f347r.cloudfront.net/1752750XXXX23-TC_Small_logo_(224_x_224)_1.png",
            "agent_use_case": "MULTI_USE",
            "agent_description": "UltraVisionNextGenSmartCommercePlatformForGlobalEnterprises"
        },
        {
            "id": "b73b4559-cc1b-479c-b4c5-a7d3dXXXXX5d",
            "agent_number": "66634",
            "service_code": "RCS-Bigbasket4",
            "status": "ACTIVE",
            "created_date": Jul 25,2025,3:19:01PM,
            "display_name": "Bigbasket_Agent_04",
            "brand_name": "RCS_Bigbasket",
            "agent_logo": "https://d2lu0ihi6f347r.cloudfront.net/175275XXXX028-TC_Small_logo_(224_x_224)_1.png",
            "agent_use_case": "MULTI_USE",
            "agent_description" : "UltraVisionNextGenSmartCommercePlatformForGlobalEnterprisesDrivenByInnovation"
        },
        {
            "id": "adc4a5ad-1c53-4cf7-9d0b-37c2XXXXX843",
            "agent_number": "66633",
            "service_code": "RCS-Bigbasket5",
            "status": "ACTIVE",
            "created_date": Jul 25,2025,3:19:01PM,
            "display_name": "Bigbasket_Agent_05",
            "brand_name": "RCS_Bigbasket",
            "agent_logo": "https://d2lu0ihi6f347r.cloudfront.net/17527XXXX5028-TC_Small_logo_(224_x_224)_1.png",
            "agent_use_case": "MULTI_USE",
            "agent_description": "UltraVisionNextGenSmartCommercePlatformForGlobalEnterprisesDrivenByInnovationAndTrustedExcellencePro"
        }
    ],
    "error": {}
}

Parameters and Descriptions for Success Response

The following are the parameters and descriptions for success response:

Parameter	Data Type	Description	Example	Mandatory?
`code`	String	Unique response code indicating API result status	RCS902	Yes
`message`	String	Human-readable response message.	RCS Agent details fetched successfully	Yes
`data`	Array of Object	Array containing RCS agent details.	`[ { ... }, { ... } ]`	Yes
`id`	String	System-generated unique Identifier (UUID) of the RCS Agent.	fb4a761b-50fe-4b3b-a29e-19XXXX02ead5	Yes
`agent_number`	String	Auto generated number by the server at the time of create agent request.	74532	Yes
`service_code`	String	A unique identifier used when sending a message. Allowed value: Any non-empty string must be unique.	RCS-Bigbasket1	Yes
`status`	String	Status of the Agent. The supported statuses include: ACTIVE, PENDING, INACTIVE, DELETED, CREATED, INITIATED, ACCEPTED, REGISTRATION_IN_PROGRESS, REGISTRATION_COMPLETED, DRAFT, PENDING_APPROVAL, and REJECTED.	ACTIVE	Yes
`created_date`	String	The date on which the agent is created.	Jul 25, 2025, 3:19:01 PM
`display_name`	String	Name that will appear for the agent. Allowed values: Any non-empty string.	Bigbasket_Agent_01	Yes
`brand_name`	String	Official name of the brand to be updated. Note: The length is up to 200 characters	RCS_Bigbasket	Yes
`agent_logo`	String	Logo of the agent.	`https://d2lu0ihi6f347r.cloudfront.net/1752XXXX77913-TC_Small_logo_(224_x_224)_1.png`	Yes
`agent_use_case`	String	Agent use case for the bot. Supported options are: `AGENT_USE_CASE_UNSPECIFIED, TRANSACTIONAL, PROMOTIONAL, OTP, and MULTI_ USE.`	MULTI_USE	Yes
`agent_description`	String	The agent description that is visible to the end-users.	UltraVision	Yes
`error`	Object	Object containing error details (empty in success response).		Yes

Sample Failure Response

The following are the sample failure responses:

No Agents Found

{
  "code": "RCS904",
  "message": "Unable to fetch RCS Agent details"
  "data": [],
  "error": {
    "error_code": "PROV_ERROR",
    "error_message": "{"status":"FAILED","message":"No agents found"}"
  }
}

RCS Not Enabled

{
  "code": "RCS601",
  "message": "RCS Channel is not enabled for this User"
  "data": [],
  "error": {
    "error_code": "RCS_CHANNEL_DISABLED",
    "error_message": "RCS Channel is not enabled for this User"
  }
}

Gateway Error

{
  "code": "RCS502",
  "message": "Internal Gateway Error"
  "data": [],
  "error": {
    "error_code": "RCS_CHANNEL_INTERNAL_ERROR",
    "error_message": "Internal Gateway Error"
  }
}

Internal Server Error

{
  "code": "RCS500",
  "message": "Internal Server Error"
  "data": [],
  "error": {
    "error_code": "RCS_CHANNEL_INTERNAL_ERROR",
    "error_message": "Internal Server Error"
  }
}

Updated about 1 month ago