Create an Agent

post

https://rcs-api.in.kaleyra.io/v1/{sid}/rcs/agent

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

The Create an Agent API allows you to create and register a new agent profile within the RCS messaging platform. The agent is responsible for a conversational entity representing a brand. It can be either Business Message Agent (BMA) or RCS Business Message Agent (RBMA).

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.

Body Params

agent_type

string

enum

required

Business messaging agent (BMA) or RCS Business Messaging (RCBM).

Allowed:

display_name

string

required

length between 1 and 40

Agent display name.

logo_url

uri

required

URL of the logo.
Must be a valid image URL ending in png, jpg or jpeg.

hero_url

uri

required

Publicly available URL of the hero image.
Must end in png, jpg or jpeg.
Cannot be modified after agent verification.

default_locale

string

Default locale.

agent_test_url

uri

Test URL for the agent.

end_point_config

string

Endpoint configuration.

primary_interaction_type

string

Primary interaction type.

service_code

string

required

length ≥ 1

Unique identifier used when sending a message.
Must be non-empty and unique.

description

string

required

length between 1 and 100

Short description explaining the agent's purpose and functionality.

phones

array of objects

required

length ≤ 3

Phone contact details. Maximum 3.

phones*

emails

array of objects

required

length ≤ 3

Email contact details. Maximum 3.

emails*

privacy

object

required

terms_conditions

object

required

color

string

required

Primary brand color in hexadecimal format.

billing_category

string

required

Billing configuration for the agent.
Documented values include CONVERSATIONAL and
NON-CONVERSATIONAL.

agent_use_case

string

enum

required

Business use case category.

Allowed:

hosting_region

string

enum

required

Hosting region.

Allowed:

status

string

Agent status.

languages

array of strings

Languages supported by the agent.

languages

rcs_provider_id

string

required

Identifier of the RCS provider.

website

array of objects

required

length ≤ 3

Official websites. Maximum 3.

website*

brand_details

object

required

Headers

api-key

string

required

API key generated from the Kaleyra account.

Responses

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Prerequisites

200RCS Agent created successfully.

400Validation failed.

401Incorrect SID or API key.

500Internal server error.