POST /api/v2/sms
Sends an SMS message to a phone number or to a Dialpad channel on behalf of a user.
Added on Dec 18, 2019 for API v2.
Tier 0 Rate limit: 100 per minute.
Tier 1 Rate limit: 800 per minute.
Servers
- https://dialpad.com/
- https://sandbox.dialpad.com/
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
infer_country_code |
Boolean | No |
If true, to_numbers will be assumed to be from the specified user's country, and the E164 format requirement will be relaxed. Default value: false |
text |
String | No |
The contents of the message that should be sent. |
media |
String | No |
Base64-encoded media attachment (will cause the message to be sent as MMS). (Max 500 KiB raw file size) |
channel_hashtag |
String | No |
[single-line only] The hashtag of the channel which should receive the SMS. |
from_number |
String | No |
The number of who sending the SMS. The number must be assigned to user or a user group. It will override user_id and sender_group_id. |
sender_group_type |
String | No |
The sender group's type (i.e. office, department, or callcenter). Possible values:
|
to_numbers[] |
Array | No |
Up to 10 E164-formatted phone numbers who should receive the SMS. |
user_id |
Integer | No |
The ID of the user who should be the sender of the SMS. |
sender_group_id |
Integer | No |
The ID of an office, department, or call center that the User should send the message on behalf of. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.