SMS -- Send

post

https://dialpad.com/api/v2/sms

Sends an SMS message to a phone number or to a Dialpad channel on behalf of a user.

Provide either to_numbers or channel_hashtag as the recipient, and either text or media as the content. A channel's hashtag is available from the channel endpoints.

Tier 0 Rate limit: 100 per minute.

Tier 1 Rate limit: 800 per minute.

Rate Limit

Tier 0: 100 per minute.

Tier 1: 800 per minute.

Registration Requirement

You must register for business messaging before using this API. This applies to both Production and Sandbox accounts.

Learn more about registration here: https://help.dialpad.com/docs/sms-registration-guide

Added on Dec 18, 2019 for API v2.

Body Params

channel_hashtag

string | null

[single-line only]

The hashtag of the channel which should receive the SMS.

from_number

string | null

The sender's phone number. The number must be assigned to a user or a user group. It will override user_id and sender_group_id.

infer_country_code

boolean | null

Defaults to false

If true, to_numbers will be assumed to be from the specified user's country, and the E164 format requirement will be relaxed.

media

string | null

Base64-encoded media attachment (will cause the message to be sent as MMS).
(Max 500 KiB raw file size)

sender_group_id

int64 | null

The ID of an office, department, or call center that the User should send the message on behalf of.

sender_group_type

string | null

enum

The sender group's type (i.e. office, department, or callcenter).

Allowed:

text

string | null

The contents of the message that should be sent.

to_numbers

array of strings | null

Up to 10 E164-formatted phone numbers who should receive the SMS.

to_numbers

user_id

int64 | null

The ID of the user who should be the sender of the SMS.

Response

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Rate Limit

Registration Requirement

200A successful response