Skip to navigation
RCSAgents

List agents

Retrieves the RCS agents available for the account of the authenticated API Key. Use the id field as agent_id when sending a message. If the account has no agents, an empty array is returned.

Do not use agents with status: false to send: the send request will be rejected with RCS_AGENT_NOT_FOUND.

Authentication

x-api-keystring

Account authentication key. The App-Key must have the RCS channel enabled.

OR
AuthorizationBearer

OAuth 2.0 access token issued by POST /api/oauth/token (client-credentials). Takes precedence over x-api-key when both are sent. See the Authentication section.

Response

List of available agents.
idstringOptional

Agent identifier. Use it as agent_id when sending a message.

namestringOptional

Display name of the agent (informational).

typeenumOptional
RCS content type. The agent's type must match the template's type when sending.
Allowed values:
statusbooleanOptional

true = enabled and available. If false, do not use this agent to send.

Errors

401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error