Create a Voice Action

post

https://api.liguelead.com.br/v1/voice-action

Creates a voice action for the authenticated client. The required credentials and config fields depend on the type/provider combination:

SCHEDULE_EVENT (microsoft): requires credentials and config.destination (e-mail). config.calendar_id and config.timezone are optional.
SEND_SMS (internal): requires the top-level message field — the text the agent sends by SMS to the number being called, up to 1600 characters. It is checked against the same blocked words as POST /v1/sms; a message carrying one is refused with 422. The SMS is charged to the app like any other SMS.
TRANSFER_CALL (internal): requires the top-level phone field (10–16 digits).
HTTP_WEBHOOK (internal): requires the top-level endpoint (HTTPS URL); the authorization_token field is optional. At the end of the call a webhook with summarized call data is sent to endpoint, using authorization_token for authorization when provided.

Microsoft credentials: tenant, client_id, client_secret. A maximum of 50 actions per client is enforced.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

SCHEDULE_EVENT with microsoft credentials and config.destination.

type

string

enum

required

Allowed:

provider

string

enum

required

Allowed:

config

object

required

Action configuration. destination is required for SCHEDULE_EVENT; from_address and destination are required for SEND_EMAIL.

name

string

required

length ≤ 100

credentials

required

phone

string

Required for TRANSFER_CALL (10–16 digits).

endpoint

uri

Required for HTTP_WEBHOOK. HTTPS URL the webhook is POSTed to at the end of the call (max 2048 characters).

authorization_token

string

Optional for HTTP_WEBHOOK. Authorization token sent in the webhook request to the client endpoint when provided (max 2048 characters).

message

string

length between 1 and 1600

Required for SEND_SMS. Text the agent sends by SMS to the number being called (max 1600 characters). A message carrying a blocked word — the same list as POST /v1/sms — is refused with 422.

Responses

201Voice action created

400Maximum number of actions (50) reached for this client.

422Validation error (invalid type/provider combination, missing required config/credentials, or invalid e-mail/phone/URL — the HTTP_WEBHOOK endpoint must be a valid HTTPS URL). For SEND_SMS: message missing, longer than 1600 characters, or carrying a blocked word.