Skip to content

Start or log voice call

POST/omnichannel/voice/calls

Initiates or logs a voice call as an omnichannel conversation on the voice channel. When the adapter supports outbound dialing, the call is started; otherwise the record serves as a log entry for calls handled by an external telephony provider.

Request

Request body

Content type application/json (required).

FieldTypeRequiredDescription
channelstringYes

Must be "voice".

One of: "voice"

subjectstringNo

Optional call subject or caller number.

Max length: 255

assigned_tointegerNo

ID of the agent to assign the call to.

channel_profile_idintegerNo

ID of the voice channel profile to use for routing.

prioritystringNo

One of: "low", "normal", "high", "urgent" · Default: "normal"

Example

{
  "channel": "voice",
  "subject": "+1-555-0199 inbound",
  "assigned_to": 5,
  "channel_profile_id": 6,
  "priority": "high"
}

Responses

201 Voice call conversation created or logged

Content type application/json, object · OmnichannelConversationV1.

FieldTypeRequiredDescription
idintegerNo

Auto-incremented primary key.

conversation_keystringNo

Unique external reference key (16 uppercase alphanumeric characters).

Max length: 80

channelstringNo

The communication channel this conversation was initiated on.

One of: "email", "web_chat", "sms", "whatsapp", "voice", "social", "internal"

subjectstring, nullableNo

Short description or subject line for the conversation.

statusstringNo

Current lifecycle status of the conversation.

One of: "open", "pending", "resolved", "closed"

prioritystringNo

Agent urgency priority level.

One of: "low", "normal", "high", "urgent"

quality_statusstringNo

AI/supervisor quality assessment of the conversation.

One of: "pending", "healthy", "watch", "at_risk"

assigned_tointeger, nullableNo

ID of the agent user currently assigned to this conversation.

channel_profile_idinteger, nullableNo

ID of the channel profile (queue/routing) this conversation belongs to.

supervisor_user_idinteger, nullableNo

ID of the supervisor user overseeing this conversation.

fallback_channelstring, nullableNo

Alternate channel to use if the primary channel becomes unavailable.

One of: "email", "web_chat", "sms", "whatsapp", "voice", "social", "internal"

first_response_due_atstring (date-time), nullableNo

SLA deadline for the first agent response.

escalation_atstring (date-time), nullableNo

Timestamp at which the conversation should be automatically escalated.

waiting_since_atstring (date-time), nullableNo

Timestamp since the conversation last entered a waiting state.

created_atstring (date-time)No
updated_atstring (date-time)No

Example request

curl -X POST "https://{tenant}.faciotech.net/api/v1/omnichannel/voice/calls" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"channel": "voice", "subject": "+1-555-0199 inbound", "assigned_to": 5, "channel_profile_id": 6, "priority": "high"}'
Loading