--- title: "List RCS agents" method: GET path: "/v1/messaging/rcs/agents" tags: ["RCS"] --- # List RCS agents `GET /v1/messaging/rcs/agents` ## Request - Base URL: `https://apihub.co.il` - URL: `https://apihub.co.il/v1/messaging/rcs/agents` - Auth: HTTP bearer **Billing:** Read (free unless it says otherwise) · **Rate limit:** 120/min ## Query parameters - `includeClosed` boolean: Include rejected and deactivated agents. ## Headers - `Idempotency-Key` string - `X-Tag` string ## Response `200` Completed - object - `id` string: Execution id — stable across internal retries; use it with GET /v1/executions/{id} - `status` 'pending' | 'processing' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'timeout' - `operation` string - `tag` string, nullable: Your X-Tag, if sent - `created_at` string, date-time - `completed_at` string, date-time, nullable - `output` object: Operation result (see each operation). While a Studio render is processing: `stage` (queued · transcribing · downloading · preparing · cleaning_voice · mixing_audio · rendering · finishing), `phase` (the engine's: download · prepare · voice · audio · encode · qa · upload, or null), `progress` (a percent, 0–100) and `progress_fraction` (0–1), `eta_seconds` (seconds left, never below 0) and `estimate_seconds` - `agents` object[] - `id` string - `brand` object, nullable - `taxId` string, required: US: the EIN, 9 digits, optionally NN-NNNNNNN. Elsewhere: the national tax or company registration id. - `address` object, required - `city` string, required - `line1` string, required - `line2` string - `state` string: Required in the US. - `country` 'US' | 'GB' | 'AT' | 'BD' | 'BR' | 'CD' | 'DE' | 'ES' | 'FR' | 'IN' | 'IT' | 'MX' | 'NG' | 'NL' | 'NO' | 'PT' | 'SE' | 'SG' | 'ZA', required: ISO 3166-1 alpha-2. Sets the launch market of agents under this brand. Spain (ES) is accepted but launches are paused at the carriers. - `postalCode` string, required - `contact` object, required - `email` string, email, required: A personal address on the company domain; free-mail and group addresses (info@, support@) are rejected by the carriers. - `phone` string, required: E.164 - `title` string - `lastName` string, required - `firstName` string, required - `legalName` string, required: Exactly as on IRS records. - `websiteUrl` string, uri, required - `displayName` string, required - `stockSymbol` string: EXCHANGE:SYMBOL. Required for PUBLIC_PROFIT. - `legalEntityType` 'LIMITED_LIABILITY_COMPANY' | 'SOLE_PROPRIETORSHIP' | 'PARTNERSHIP' | 'CORPORATION' | 'S_CORPORATION', required - `organizationType` 'PRIVATE_PROFIT' | 'PUBLIC_PROFIT' | 'NON_PROFIT' | 'GOVERNMENT', required - `id` string - `status` 'draft' | 'vetting' | 'verified' | 'rejected': draft = not filed yet (still editable). - `createdAt` string, date-time - `liveAt` string, date-time, nullable - `status` 'requested' | 'changes_requested' | 'brand_vetting' | 'agent_review' | 'testing' | 'launch_review' | 'launching' | 'live' | 'rejected' | 'deactivated' - `country` string: Launch market (ISO 3166-1 alpha-2). US agents run through the carriers automatically; other markets are filed by our team and skip the testing and launch_review steps (send the launch request while the agent is still in review). - `profile` object: The agent's public profile. At least one of phone, website or email is required. - `email` object - `label` string, required - `address` string, email, required - `phone` object - `label` string, required - `number` string, required: E.164 - `heroUrl` string, uri, required: Banner, 1440x448, max 200 KB. Upload through POST /v1/rcs/assets. - `logoUrl` string, uri, required: 224x224, max 50 KB. Upload any image through POST /v1/rcs/assets to get a compliant URL. - `website` object - `url` string, uri, required - `label` string, required - `termsUrl` string, uri, required - `brandColor` string, required: Hex colour, e.g. #1A73E8. Needs 4.5:1 contrast against white. - `description` string, required - `privacyPolicyUrl` string, uri, required - `useCase` 'MULTI_USE' | 'PROMOTIONAL' | 'TRANSACTIONAL' | 'OTP' - `accountId` string, nullable: The rcs inbox account, created once the agent exists with the carriers. - `createdAt` string, date-time - `profileId` string - `reviewNote` string, nullable: Our note while status is changes_requested. - `displayName` string - `requestedAt` string, date-time, nullable - `submittedAt` string, date-time, nullable - `testDevices` object[] - `phoneNumber` string - `inviteStatus` 'PENDING' | 'ACCEPTED' | 'DECLINED': The phone must accept the invite in its messaging app before it receives messages. - `testDeviceId` string - `declineReason` string, nullable - `launchRequest` object, nullable - `consent` object, required - `doubleOptIn` boolean, required - `callToAction` string, required: The opt-in wording people agree to. - `helpResponse` string, required - `optInMessage` string, required - `optInMethods` object[], required - `type` 'SMS' | 'WEBSITE' | 'MOBILE_APP' | 'QR_CODE' | 'SALE_POINT' | 'OTHER', required - `description` string: Required when type is OTHER. - `optOutResponse` string, required - `callToActionUrl` string, uri: Required for WEBSITE opt-in. - `doubleOptInMessage` string: Required when doubleOptIn is true. - `callToActionMediaUrl` string, uri: Screenshot of the opt-in. Required for WEBSITE and MOBILE_APP opt-in. - `interactions` object[], required - `type` 'TRANSACTIONAL_UPDATES' | 'CUSTOMER_SUPPORT' | 'LOYALTY_OR_REWARD' | 'MARKETING_OR_PROMOTIONAL' | 'ACCOUNT_ALERTS' | 'TWO_WAY_CONVERSATION' | 'OTHER', required - `description` string: Required when type is OTHER. - `testVideoUrl` string, uri, required: Public video of a test phone sending START, STOP and HELP plus one example conversation. - `agentOverview` string, required - `companyOverview` string, required - `messageExamples` string[], required - `additionalInformation` string - `smsFallbackFrom` string, nullable - `carrierApprovals` object[] - `scope` 'carrier' | 'hub' | 'bot' - `status` 'PENDING' | 'SUBMITTED' | 'APPROVED' | 'REJECTED' - `carrier` string, nullable - `approvalId` string - `approvedAt` string, date-time, nullable - `rejectedReason` string, nullable - `error` string, nullable - `usage` object - `credits_charged` number, nullable - `credits_reserved` number - `estimated_credits` number - `cost_source` 'provider_reported' | 'calculated' | 'estimated' | 'null', nullable - `provider_usage` object, nullable: Normalised consumption, e.g. { VIDEO_SECOND: 22.4 } - `balance` object - `available` number - `reserved` number ## Other responses - `400`: Invalid input - `402`: Insufficient credits / project budget - `404`: Resource not found (or not yours) - `429`: Rate limited - `503`: Service temporarily paused --- [API](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai.md) · [All operations](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai/llms.txt) · [OpenAPI document](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai/revisions/a8caa42835ce?raw)