API Endpoint
POST
https://api.dropcowboy.com/v1/smsSMS Attributes
Required Body Keys
team_id
STRING
Located on the API Setting tab.
Example: <Your Account>
YES
secret
STRING
Located on the API Setting tab.
Example: <Your Secret>
YES
caller_id
STRING
The phone number to forward calls and texts to when the contact replies to your message. Must be in E.164 format.
Example: +15557778888
YES
phone_number
STRING
Your contact's phone number in E.164 format.
Example: +15552223333
YES
pool_id
STRING
The ID of the private number pool you registered to send SMS messages.
YES
sms_body
STRING
Plain text containing your message. Character limit is 160.
Example: Hello World
YES
opt_in
BOOLEAN
Confirmation that you obtained OPT-IN permission to send SMS to the recipient as required by law.
Example: true
YES
Optional Body Keys
foreign_id
STRING
A value to identify this drop in your system. Will be passed through to you in the webhook callback. Max length 256 characters.
Example: <Your system's ID>
Optional
callback_url
STRING
Override the default RVM webhook URL that you specified in your API settings.
Example: http://example.com
Optional, highly recommended
Example Request
Invoke our api from your application by sending an HTTP POST containing a json document with the attributes listed below. Once delivery is attempted, you will receive a callback containing the delivery status to the webhook you specified in your api settings.
Requires two headers: x-team-id and x-secret. Both must be sent with each request.
Located on the API Setting tab. (Required)
Located on the API Setting tab. (Required)
Your contact's phone number in E.164 format. (Required)
The phone number to forward calls and texts to when the contact replies to your message. Must be in E.164 format. (Required)
The ID of the private number pool you registered to send SMS messages. (Required)
Plain text containing your message. Character limit is 160. (Required)
Confirmation that you obtained OPT-IN permission to send SMS to the recipient as required by law. (Required)
Override the default RVM webhook url that you specified in your API settings.
A value to identify this drop in your system. Will be passed through to you in the webhook callback.
Request accepted. Results include accepted_count and rejected details.
Request accepted. Results include accepted_count and rejected details.
Example Response
Last updated
Was this helpful?