Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Inkbox

Send and retrieve SMS messages, and operate hosted-agent voice calls through Inkbox's API-first communications platform.

Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

Connector
Authentication

Inkbox

API Key

Inkbox

Connect Inkbox to send texts and operate hosted-agent phone calls.

Set up in Inkbox

  1. Prepare the Inkbox account or service that the workflow will access. Grant access to the required resources and operations.

  2. API Key: Create or copy an Inkbox API key from the Inkbox console.

Set up in StackAI

  1. Open Settings → Connections, add a connection, and select Inkbox.

  2. Enter the credentials and connection details in the fields below.

  3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

Connection fields

StackAI field
Required
What to enter

API Key

Yes

Create or copy an Inkbox API key from the Inkbox console. Provider instructions.

Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

Use an action

  1. Add the required Inkbox action to the workflow.

  2. Select a connection when the action requests one.

  3. Complete the required fields. Use the reference picker when a value comes from another workflow step.

  4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

Actions

Send Text

Send an SMS text from an Inkbox phone number.

Inputs

Field
Type
Required
Description

Phone Number ID

string

Yes

The Inkbox phone number that sends the text.

Recipient

string

Yes

Recipient phone number in E.164 format.

Message

textarea

Yes

Text message body.

Outputs

Field
Type
Description

Text Message

object

The Inkbox text message.

List Texts

List recent SMS and MMS messages for an Inkbox phone number.

Inputs

Field
Type
Required
Description

Phone Number ID

string

Yes

The Inkbox phone number whose texts to list.

Limit

integer

No

Maximum number of messages to return. Default: 50.

Offset

integer

No

Number of newest messages to skip. Default: 0.

Read State

boolean

No

Optionally return only read or unread messages.

Outputs

Field
Type
Description

Text Messages

object_array

The matching Inkbox text messages.

Get Text

Get a single SMS or MMS message from Inkbox.

Inputs

Field
Type
Required
Description

Phone Number ID

string

Yes

The Inkbox phone number that owns the message.

Text ID

string

Yes

The text message to retrieve.

Outputs

Field
Type
Description

Text Message

object

The Inkbox text message.

Place Hosted-Agent Call

Place a phone call operated by Inkbox Voice AI.

Inputs

Field
Type
Required
Description

From Number

string

Yes

Active Inkbox caller ID in E.164 format.

To Number

string

Yes

Destination phone number in E.164 format.

Call Reason

textarea

Yes

Task brief for Inkbox Voice AI.

Voicemail Detection

select (string)

No

Choose whether Inkbox ends the call when voicemail is detected. Available values: Detect voicemail and end the call, Stay connected to leave a voicemail. Default: enabled.

Outputs

Field
Type
Description

Call

object

The Inkbox call.

Rate Limit

object

Rolling call usage returned when placing a call.

List Calls

List calls for an Inkbox agent identity.

Inputs

Field
Type
Required
Description

Agent Identity ID

string

No

Agent identity whose calls to list, if required by the API key.

Limit

integer

No

Maximum number of calls to return. Default: 50.

Offset

integer

No

Number of newest calls to skip. Default: 0.

Outputs

Field
Type
Description

Calls

object_array

The matching Inkbox calls.

Get Call

Get a single Inkbox call by ID.

Inputs

Field
Type
Required
Description

Call ID

string

Yes

The Inkbox call to retrieve.

Outputs

Field
Type
Description

Call

object

The Inkbox call.

Rate Limit

object

Rolling call usage returned when placing a call.

Hang Up Call

End an active Inkbox call.

Inputs

Field
Type
Required
Description

Call ID

string

Yes

The live Inkbox call to end.

Outputs

Field
Type
Description

Call

object

The Inkbox call.

Rate Limit

object

Rolling call usage returned when placing a call.

Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.

Last updated

Was this helpful?