Skip to navigation
OMIACalls

Launch a call

Originates a conversational AI call to a destination number using the specified agent and dial type. Every variable defined by the agent must be covered either by the variables object of the request or by a default value configured in the agent — values sent in the request override the agent defaults. An ACCEPTED status only indicates that the call was accepted by the voice provider; the final result is notified through the webhook.

Authentication

x-api-keystring
Account authentication key.
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.

Request

This endpoint expects an object.
phone_numberstringRequiredformat: "^\d{10}$"

10-digit Mexican phone number, without country code.

agentstringRequired

Agent identifier obtained through GET /v1/omia/agents.

dial_typestringRequired

Dial type identifier obtained through GET /v1/omia/dial-types.

variablesmap from strings to strings or doubles or booleansOptional

Values for the variables defined by the agent. Values sent here override the agent defaults. Any agent variable not covered by the request or by a non-empty default causes the request to be rejected.

Response

Result of the origination request.
message_idstringOptional
Unique identifier of the call. It should be kept to correlate subsequent webhook events.
statusenumOptional
Result of the origination request.
Allowed values:
operatorstringOptional
Phone operator identified for the destination number.
is_mobilebooleanOptional
Indicates whether the number corresponds to a mobile line.
agentstringOptional
dial_typestringOptional
phone_numberstringOptional