Skip to main content
POST
Send Test Contact Card

Overview

Sends the agent’s contact card to a number you choose so you can see how it looks on a real device.
Each request sends a real message and is billed to your organization like any other outbound message. It is not a preview.
Limited to 5 requests per minute per agent. The test is independent of the automatic delivery switch, so you can send one whether or not vcf_delivery_enabled is on, and you can repeat it. Requires an admin, owner, operator, or prompter role.

Headers

string
required
Your API key for authentication.

Path Parameters

string
required
The agent’s unique identifier.

Body Parameters

string
required
Destination number in E.164, for example +15550000000. Anything that does not normalize to E.164 returns 400 BAD_REQUEST.
string
required
One of sms, imessage, or rcs. Any other value returns 400 BAD_REQUEST listing the accepted values.

Response

string
The channel you requested.
string
The destination number, normalized to E.164.
string
The agent number the card was sent from.
string
How it was actually delivered: mms, imessage, or rcs. This can differ from channel when the requested channel falls back.
string | null
Provider identifier for the sent message, or null when the channel does not return one.
string
Present only when there is something worth saying about how the send was handled.
null | array
null on success, or a list of error objects if the request failed. Returns 402 PAYMENT_REQUIRED when the organization’s balance will not cover a message. Returns 409 when the channel cannot carry the card, with error set to NO_BOUND_NUMBER, NO_RCS_SENDER, RCS_SENDER_NOT_READY, or IMESSAGE_NOT_CONFIGURED.

Docs for agents: llms.txt