Skip to main content
POST
Send message to an agent from your own platform

Authorizations

token
string
query
required

Vida API Token

Body

application/json
targetAgent
string
required

Agent account ID, phone number, or username

Example:

"agent123"

sourceAddress
string
required

Sender phone number or address

Example:

"+15551231234"

message
string
required

Message text

Example:

"Hello there"

attachments
object[]
Example:
context
object
Example:
metadata
object
Example:
outboundMessageWebhookUrl
string

Webhook URL (POST) to deliver agent responses to. If not specified will look for default outboundMessageWebhookUrl webhook settings.

Example:

"https://example.com/hook"

Response

Message queued

success
boolean
Example:

true

messageUuid
string
Example:

"uuid"