API Reference
Start typing to search…

Send SMS

post
https://api.whippy.co/v1/messaging/sms

Creates and Sends an SMS or MMS message.

Messages will be sent using the channel that corresponds to the from request parameter. The message body must be less than 1000 characters. Attachment-only messages are also accepted.

If there is no contact corresponding to the to parameter for the organization, a new contact will be created, along with a conversation with the from number channel. If there is an existing contact but no conversation, a new conversation will be created.

The opt_in_to_all_channels and opt_in_to params are optional and they will be processed in the cases where a new contact is created. These params reflect which of the organization channels the contact will be opted in to.

Note: The Messaging API is designed for creating and managing messages and can only process POST requests. To view messages, navigate to the Conversation section where you can use the Show Conversation API to GET messages within a specific conversation.

Body Params

Send SMS Params

attachments
array of strings

List of attachment URLs

attachments
string
length ≤ 1000

Message body

string
enum

Status to set for the conversation. If not provided, the conversation status remains unchanged.

Allowed:
string
required

Phone of an existing channel belonging to your organization

opt_in_to
array of objects

Setting to opt in contact to specific channels

opt_in_to
boolean

Setting to opt in contact to all channels

date-time

Scheduling time for the message. Requires ISO 8601 format.

string
required

Destination phone number

Responses

Callback

Updated 6 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 6 months ago