Drop Cowboy

RINGLESS VOICEMAIL & SMS AS LOW AS $0.004. GET TEN PERCENT OFF YOUR FIRST MONTH. USE PROMO CODE STARTUP.

API

Getting Started

Directly integrate ringless voicemail delivery into your software. Successful deliveries are deducted from your account balance based on the rate dictated by your monthly subscription plan. Invoke the Drop Cowboy 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 contained in your account.

Sending Ringless Voicemail via API

https://api.dropcowboy.com/v1/rvm
HTTP POST

Content-Type: application/json

Attributes

Name

Type

Description

Required

team_id
STRING

Located on the API Setting tab.
Example: <Your Account>

Required
secret
STRING

Located on the API Setting tab.
Example: <Your Secret>

Required
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>

Required
brand_id
STRING

Located on in your account's trust center tab.
Example: <Your Brand GUID>

Required
recording_id
STRING

The ID of the audio recording to send to your contacts. Located on in your account's recordings tab.
Example: <Your Recording GUID>
*Not required if you are using audio_url or voice_id

Required *
voice_id
STRING

The ID of the Mimic AITM voice to use when reading your tts_body. Located on in your account's voices tab.
Example: <Your Voice GUID>
*Not required if you are audio_url or recording_id.
Must use in conjunction with tts_body.

Required *
tts_body
STRING

The text you want Mimic AITM to convert to speech using the voice_id you specify.
Example: Hey Joe, this is Bob from Brand. I'm calling you because...
*Required if using voice_id

Required *
audio_url
STRING

Use of this property requires special approval. Please contact support.
A url to the voicemail audio to play (mp3 or wav).
Example: https://example.com/your-file.mp3
*Not required if you are using recording_id or voice_id

audio_type
STRING

Use of this property requires special approval. Please contact support.
The file type of audio_url: 'mp3' or 'wav'.
Example: 'mp3'

phone_number
STRING

Your contact's phone number in E.164 format.
Example: '+15552223333'

Required
forwarding_number
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'

phone_ivr_id
STRING

Optional: The IVR to use when your contact calls you back. Located on in your account's phone ivr tab.
Example: <Your IVR GUID>

pool_id
STRING

The ID of the private number pool to select phone numbers from based on geographic location of your contact.
Defaults to the public pool of shared numbers.

postal_code
STRING

The zip code / postal code of your contact. Supplying a value for postal code is optional but provides more accurate compliance with TCPA calling hours.
Example: '02101' or '90210-0001'

callback_url
STRING

Override the default RVM webhook url that you specified in your API settings.
Example: 'http://example.com'

byoc
OBJECT

Wholesale customers are able to specify SIP Trunks and STIR/SHAKEN credentials.
Please contact us for details

Example (Pre-recorded Audio / recording_id)

Example (Mimic AITM Voice Clone / voice_id)
Example (Remotely Hosted Audio / audio_url)
Results
System will call the callback url specified in the settings tab with json content like this:
Success
Failure
Possible Error Reasons
Name
Description
Error from SIP Server
The phone number is not reachable - usually because it is no longer in service.
Temporarily unreachable
The phone number is experiencing a localized service outage.
VoiceMail NotDetected
The phone number does not have voicemail capability.
No Funds
Your Drop Cowboy account is out of money.
Known Litigator
The phone number is a known TCPA litigator.
Not Mobile
The phone number is a landline (only possible to get this error via the Drop Cowboy UI and not through the API).
User Busy
The telephone carrier actively rejected our voicemail attempt - usually because they marked your message attempt as spam.
Internal DNC
The phone number is on your Drop Cowboy DNC list and therefore blocked.
TCPA Hours
You attempted to deliver a voicemail message to your contact outside of TCPA callable hours.
Getting Started
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.
Sending SMS Text Messages
https://api.dropcowboy.com/v1/sms
HTTP POST
Content-Type: application/json
Attributes
Name
Type
Description
Required
team_id
STRING
Located on the API Settings tab.
Example: <Your Account>
 Required
secret
STRING
Located on the API Setting tab.
Example: <Your Secret>
 Required
phone_number
STRING
Your contact's phone number in E.164 format.
Example: '+15552223333'
 Required
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'
 Required
pool_id
STRING
The ID of the private number pool you registered to send SMS messages.
 Required
sms_body
STRING
Plain text containing your message. Character limit is 160.
Example: 'Hello world'
 Required
opt_in
BOOLEAN
Confirmation that you obtained OPT-IN permission to send SMS to the recipient as required by law.
Example: true
 Required
callback_url
STRING
Override the default RVM webhook url that you specified in your API settings.
Example: 'http://example.com
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>
Example
Results
System will call the callback url specified in the settings tab with json content like this:
Success
Failure
Possible Error Reasons
Name
Description
Invalid message
The contents of your SMS message are not acceptable or violate S.H.A.F.T
Spam detected
The phone carrier determined your message is spam.
Invalid caller ID or not SMS enabled
SMS does not support arbitrary caller IDs. You must use a phone number rented from Drop Cowboy as your caller ID.
No Funds
Your Drop Cowboy account is out of money.
Known Litigator
The phone number is a known TCPA litigator.
Prohibited by carrier or not SMS enabled
The phone number does not support SMS or the carrier blocked delivery of your message.
Message too long
Your message must be less than 160 characters in length.
Opted out
The phone number opted-out from receiving SMS from you.
Internal DNC
The phone number is on your Drop Cowboy DNC list and therefore blocked.
Temporarily unreachable
The phone number is experiencing a localized service outage.
Too Many
You tried to send to the same phone number more than 3 times in 3 days.
Unregistered Brand
You didn't pass brand_id or your brand is not registered yet.
Unregistered Recording
You didn't pass recording_id or your recording is not available yet.
Create Contact List
https://api.dropcowboy.com/v1/list
HTTP POST
Headers
Name
Description
Required
x-team-id
The team_id assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -> API page.
 Required
x-secret
The secret assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -> API page.
 Required
Attributes
Name
Description
Required
list_name
String containing the desired name.
 Required
Example JSON Body
Results
An object containing the following:
Name
Description
list_id
The UUID of the list. Use this value in other calls to the contact list api endpoints. It is safe to cache this value client side in your app.
list_name
A string containing the name of the list.
created_at
Milliseconds since epoch of when the list was created.
Example Results
Rename Contact List
https://api.dropcowboy.com/v1/list/{LIST_ID}
HTTP POST
URI Parameters
Name
Description
LIST_ID
Is the UUID value returned in the api results when creating a list or getting a list from the /list endpoint.
Headers
Name
Description
Required
x-team-id
The team_id assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -> API page.
 Required
x-secret
The secret assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -> API page.
 Required
Attributes
Name
Description
Required
list_name
String containing the desired name.
 Required
Example JSON Body
Results
This endpoint will return a HTTP STATUS 200 if successful.
Get Contact List Details
https://api.dropcowboy.com/v1/list/{LIST_ID}
HTTP GET
URI Parameters
Name
Description
LIST_ID
Is the UUID value returned in the api results when creating a list or getting a list from the /list endpoint.
Headers
Name
Description
Required
x-team-id
The team_id assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -> API page.
 Required
x-secret
The secret assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -> API page.
 Required
Results
An array of objects containing:
Name
Description
list_id
The UUID of the list. Use this value in other calls to the contact list api endpoints. It is safe to cache this value client side in your app.
list_name
A string containing the name of the list.
created_at
Milliseconds since epoch of when the list was created.
contact_count
The total number of contacts in the list.
Example Results
Delete Contact List
https://api.dropcowboy.com/v1/list/{LIST_ID}
HTTP DELETE
URI Parameters
Name
Description
LIST_ID
Is the UUID value returned in the api results when creating a list or getting a list from the /list endpoint.
Headers
Name
Description
Required
x-team-id
The team_id assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -> API page.
 Required
x-secret
The secret assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -> API page.
 Required
Results
This endpoint will return a HTTP STATUS 200 if successful.
Append Contacts to List
https://api.dropcowboy.com/v1/list/{LIST_ID}/contacts
HTTP POST
URI Parameters
Name
Description
LIST_ID
Is the UUID value returned in the api results when creating a list or getting a list from the /list endpoint.
The number of contacts that can be appended to this list is dependent on the amount of data you submit per contact. If you’re only submitting phone numbers, it’s recommended to submit in batches of 10,000. If you are sending full contact data including addresses and custom fields, it’s recommended to submit in batches of less than 10,000. The api is restricted to requests less than 10MB and taking less than 29 seconds to process.
Headers
Name
Description
Required
x-team-id
The team_id assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -> API page.
 Required
x-secret
The secret assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -> API page.
 Required
Attributes
Name
Description
Required
fields
Array of strings that define the data types being passed in the Values attribute. It is acceptable tohave repeat field types specified if your contacts have multiple phone numbers, pass in the value of “phone” multiple times in this array. Possible field types are: record_id, first_name, last_name, company, email, phone, address1, address2, city, state, postal, country, custom1, custom2, custom3, custom4, custom5.
 Required
values
An array of arrays. Inner arrays contain the values associated with the field types you specify in the fields attribute. You may pass in up to 10,000 contacts per api call.
 Required
region
The ISO country code to use when converting your phone number values to E.164 format. If yourphone numbers are already formatted in E.164 then the region attribute is ignored. Defaults to US.
Example JSON Body for a Contact With 3 Phone Numbers
Results
Name
Description
accepted_count
The number of contacts appended to the list.
rejected
An array of objects containing the index of the rejected contact from the value array that you passed to the api and the reason that contact was rejected.
Example Results
Getting Started
Invoke our brand api from your application by sending an HTTP GET containing with the attributes listed below.
Listing Brands
https://api.dropcowboy.com/v1/brand
HTTP GET
Content-Type: application/json
Headers
x-team-id
The team_id assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -> API page.
 Required
x-secret
The secret assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -> API page.
 Required
Example Results
Getting Started
Invoke our number pool api from your application by sending an HTTP GET containing with the attributes listed below.
Listing Number Pools
https://api.dropcowboy.com/v1/pool
HTTP GET
Content-Type: application/json
Headers
x-team-id
The team_id assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -> API page.
 Required
x-secret
The secret assigned to your Drop Cowboy account. This value is found by logging into Drop Cowboy and visiting the My Account -> API page.
 Required
Example Results
Learn How to Use Ringless Voicemail with your Business
Our How to Guide has everything you need to know to integrate voicemail drops into your business.
Learn More
Integrate Ringless Voicemail With 1400+ Applications
Zapier integrates Drop Cowboy Ringless Voicemail Into 1400+ Applications.
See How
Directly Integrate Ringless Voicemail Into Your App
Drop Cowboy offers on open API for developers to directly integrate ringless voicemail into your software application.
Learn More
GET TEN PERCENT OFF YOUR FIRST MONTH. PROMO CODE STARTUP.
RINGLESS VOICEMAIL & SMS AS LOW AS $0.004 PER MESSAGE.
VIEW PRICING
Millions of Voicemails Delivered Daily
Millions of Voicemails Delivered Daily
We support sending ringless voicemail to more than 80 countries including
Australia
Austria
Belgium
Canada
Denmark
Finland
France
Germany
Ireland
Mexico
The Netherlands
New Zealand
Norway
Spain
Sweden
Switzerland
United Kingdom
United States
See for yourself why so many have embraced ringless voicemail!
There's no monthly fees, minimums, or commitment to get started.
Drop Cowboy
Drop Cowboy ©  All rights reserved.
Use of this service requires that you comply with all rules, regulations, and laws including the TCPA, TSR, national do-not-call registry . You must obtain opt-in permission from your contacts where required. Additional restrictions apply. See our Terms of Service for details.

If you received an unwanted message from one of our customers, please report it to support@dropcowboy.com .

All product names, logos, and brands are property of their respective owners. Use of these names, logos, and brands does not imply endorsement.
  
30 N. Gould St., Ste 2890
Sheridan, WY 82801
USA
1-855-550-1992
info@dropcowboy.com