Skip to main content

send_sms

Facts​

DescriptionSend an SMS
SchemaConnectors.Dialpad.functions.SendSms
ServiceDialpad

Input parameters​

Required input parameters

dialpad_access_tokenslack#/types/credential/oauth2Required

Dialpad access token. See the authentication section for details.

from_numberstringRequired

The number (in E.164 format) from which to send the SMS

Examples
+14155551234
textstringRequired

The body of the message to send

Examples
Incident 2234 has been resolved
to_numbersarrayRequired

An array of phone numbers (in E.164 format) that the SMS will be sent to

Examples
+14155551234
+14155552345
+14155559876

Output parameters​

Required output parameters

from_numberstringRequired

Sending number

message_statusstringRequired

SMS status

textstringRequired

SMS text content

Authentication​

End-user authentication

User workflows that include a connector function relying on end-user authentication can only be started with a link trigger.

{
"dialpad_access_token": {
"credential_source": "END_USER"
}
}

End-user experience: User will be prompted to link their external account via OAuth when they first start the workflow that contains this connector.

Developer experience: Developer does not have to implement authentication in the app.

Usage info​

First, import Connectors from deno-slack-hub into your project's import_map.json file, like this:

import_map.json
{
"imports": {
"deno-slack-hub/": "https://deno.land/x/deno_slack_hub@2.2.0/",
"deno-slack-sdk/": "https://deno.land/x/deno_slack_sdk@2.14.2/",
"deno-slack-api/": "https://deno.land/x/deno_slack_api@2.8.0/"
}
}

Next, import Connectors at the top of your workflow's definition file:

my_workflow_file.ts
import { Connectors } from "deno-slack-hub/mod.ts";

Finally, add the connector as a step in your workflow just like you would a Slack function.

my_workflow_file.ts
SomeWorkflow.addStep(
Connectors.Dialpad.functions.SendSms, {
//...

🧙🏼 Your admin may need to approve the connector first. If your workspace has been configured to only allow admin-approved apps, the CLI will prompt you to send an admin approval request the first time you try to use a connector that hasn't been approved by an admin yet. While waiting for admin approval, the CLI may report an error like this:

Workflow function X is referring to an unknown step output parameter Y

You can safely ignore this error; it will go away as soon as your workspace admin approves your request to use the connector.