> ## Documentation Index
> Fetch the complete documentation index at: https://developers.redo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SupportVoiceIntegration

> The store's phone number for calls and voicemail, and how its calls are handled, as the Voice & SMS settings page shows them.

**Required scopes:** [`support_config_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-support_config_read), [`support_settings_write`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-support_settings_write)

**connected** `Boolean!` *required*

Whether the account is connected, as the channels settings page shows it. Gmail, Outlook, custom email, Facebook, Instagram, Attentive, Postscript and TikTok are false until their account is linked, such as an email integration with no mailbox. Every other type is connected while it exists.

**id** `ID!` *required*

A globally-unique identifier. Treat it as an opaque handle: pass it back to the API (e.g. to `node(id:)`) to refetch this object, but don't parse it or build one yourself — its format is not part of the contract and may change.

**inbound** `[SupportIntegrationInbound!](/docs/api-reference/v3/reference/support/support-integration-inbound)` *required*

How its incoming messages are syncing.

**fields**

**blockedUntil** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

When syncing may start again after the provider held it back. Null when it isn't held back.

**failedCount** `Int!` *required*

Incoming messages that failed and won't be retried.

**lastEventAt** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

When the last incoming message or event arrived. Null when none has.

**lastPolledAt** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

When the help desk last checked for new messages. Null for a channel that pushes them instead.

**latestFailure** `[SupportIntegrationInboundFailure](/docs/api-reference/v3/reference/support/support-integration-inbound-failure)`

The latest failure. Null when none is recorded.

**fields**

**at** `[DateTime!](/docs/api-reference/v3/reference/common/date-time)` *required*

When it failed.

**errorType** `String!` *required*

What kind of failure it was, as the sync recorded it.

**message** `String!` *required*

The failure's message, cut to 300 characters and an ellipsis.

**pendingFailureCount** `Int!` *required*

Incoming messages that failed and are still being retried.

**name** `String`

The inbox's email address for Gmail, Outlook and custom email, the page name for Facebook and Instagram. Null for other types, and while the account isn't connected.

**permissionsRevoked** `Boolean!` *required*

Whether the provider revoked Redo's access, so the integration needs reconnecting.

**phoneNumber** `String`

The number customers call, in E.164, such as +15555550100, also while voice is off. Null while none is assigned. Costs 1, shared with `voiceSettings`.

**syncError** `String`

The integration's current error, cut to 300 characters and an ellipsis. Null when it has none.

**type** `[SupportIntegrationType!](/docs/api-reference/v3/reference/support/support-integration-type)` *required*

What the integration connects to.

**voiceSettings** `[SupportVoiceSettings](/docs/api-reference/v3/reference/support/support-voice-settings)`

How calls are handled, as the Voice & SMS settings page's Voice and Testing tabs set them. Costs 1, shared with `phoneNumber`. Null when the integration has no voice line provisioned yet.

**fields**

**allowHoldingCallsInQueue** `Boolean!` *required*

Whether callers keep waiting in the queue after the ring window instead of going to voicemail.

**enabled** `Boolean!` *required*

Whether the number takes calls. While it's off, calls from numbers other than `testPhoneNumbers` hear that the phone isn't set up and are hung up.

**holdMusic** `[SupportVoiceAudio](/docs/api-reference/v3/reference/support/support-voice-audio)`

Played while a caller waits in the queue. Null plays Redo's default music.

**fields**

**audioUrl** `String!` *required*

The public URL of its `.mp3` or `.wav` file, which the phone provider fetches when a call plays it.

**name** `String!` *required*

The name the settings page shows for it.

**hours** `[SupportVoiceHours!](/docs/api-reference/v3/reference/support/support-voice-hours)` *required*

When calls are taken.

**fields**

**enabled** `Boolean!` *required*

Whether the hours apply. When false, or with no `timeZone`, calls are taken at any time.

**timeZone** `String`

IANA time zone the hours are in, such as America/New\_York. Null when none is set.

**weeklyHours** `[\[SupportBusinessHoursDay!\]!](/docs/api-reference/v3/reference/support/support-business-hours-day)` *required*

Weekly hours, Monday through Sunday, with at most one time block a day. A day that isn't enabled, or has no block, is closed.

**inboundGreeting** `[SupportVoiceMessage!](/docs/api-reference/v3/reference/support/support-voice-message)` *required*

Played when a customer calls.

**fields**

**audio** `[SupportVoiceAudio](/docs/api-reference/v3/reference/support/support-voice-audio)`

The recording. Null when none is saved.

**enabled** `Boolean!` *required*

Whether calls play it. Only the outbound greeting can be off; calls always play the inbound greeting, the off-hours message and the voicemail message.

**kind** `[SupportVoiceMessageKind!](/docs/api-reference/v3/reference/support/support-voice-message-kind)` *required*

Whether it plays its text or its recording.

**text** `String`

The text read aloud. Null when none is saved.

**offHoursMessage** `[SupportVoiceMessage!](/docs/api-reference/v3/reference/support/support-voice-message)` *required*

Played to a call outside the hours.

**fields**

**audio** `[SupportVoiceAudio](/docs/api-reference/v3/reference/support/support-voice-audio)`

The recording. Null when none is saved.

**enabled** `Boolean!` *required*

Whether calls play it. Only the outbound greeting can be off; calls always play the inbound greeting, the off-hours message and the voicemail message.

**kind** `[SupportVoiceMessageKind!](/docs/api-reference/v3/reference/support/support-voice-message-kind)` *required*

Whether it plays its text or its recording.

**text** `String`

The text read aloud. Null when none is saved.

**outboundGreeting** `[SupportVoiceMessage!](/docs/api-reference/v3/reference/support/support-voice-message)` *required*

Played once a call a team member places connects.

**fields**

**audio** `[SupportVoiceAudio](/docs/api-reference/v3/reference/support/support-voice-audio)`

The recording. Null when none is saved.

**enabled** `Boolean!` *required*

Whether calls play it. Only the outbound greeting can be off; calls always play the inbound greeting, the off-hours message and the voicemail message.

**kind** `[SupportVoiceMessageKind!](/docs/api-reference/v3/reference/support/support-voice-message-kind)` *required*

Whether it plays its text or its recording.

**text** `String`

The text read aloud. Null when none is saved.

**playAutomatedMessageWhenAllOffline** `Boolean!` *required*

Whether a call plays the off-hours message before voicemail when no team member is available.

**ringingStrategy** `[SupportVoiceRingingStrategy!](/docs/api-reference/v3/reference/support/support-voice-ringing-strategy)` *required*

How an incoming call rings the team.

**sendToVoicemailWhenAllOffline** `Boolean!` *required*

Whether a call within hours goes straight to voicemail when no team member is available.

**testPhoneNumbers** `[String!]!` *required*

Numbers, in E.164, whose calls connect while `enabled` is false, for testing.

**voicemailMessage** `[SupportVoiceMessage!](/docs/api-reference/v3/reference/support/support-voice-message)` *required*

Played before a voicemail records.

**fields**

**audio** `[SupportVoiceAudio](/docs/api-reference/v3/reference/support/support-voice-audio)`

The recording. Null when none is saved.

**enabled** `Boolean!` *required*

Whether calls play it. Only the outbound greeting can be off; calls always play the inbound greeting, the off-hours message and the voicemail message.

**kind** `[SupportVoiceMessageKind!](/docs/api-reference/v3/reference/support/support-voice-message-kind)` *required*

Whether it plays its text or its recording.

**text** `String`

The text read aloud. Null when none is saved.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.