Default
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.
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)
A value to identify this drop in your system. Will be passed through to you in the webhook callback. Max length 256 characters. (Required)
Located on in your account's trust center tab. (Required)
Your contact's phone number in E.164 format. (Required)
The ID of the audio recording to send to your contacts. Located on in your account's recordings tab. *Not required if you are using audio_url or voice_id
The ID of the Mimic AITM voice to use when reading your tts_body. Located on in your account's voices tab. *Not required if you are audio_url or recording_id. Must use in conjunction with tts_body.
The text you want Mimic AITM to convert to speech using the voice_id you specify. *Required if using voice_id
Use of this property requires special approval. Please contact support. | A url to the voicemail audio to play (mp3 or wav). *Not required if you are using recording_id or voice_id
Use of this property requires special approval. Please contact support.
The phone number to forward calls and texts to when the contact replies to your message. Must be in E.164 format.
The IVR to use when your contact calls you back. Located on in your account's phone ivr tab.
The ID of the private number pool to select phone numbers from based on geographic location of your contact.
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.
Override the default RVM webhook url that you specified in your API settings.
Wholesale customers are able to specify SIP Trunks and STIR/SHAKEN credentials.
Request accepted. Delivery status delivered via webhook callback.
Request accepted. Delivery status delivered via webhook callback.
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.
Requires two headers: x-team-id and x-secret. Both must be sent with each request.
Created. Returns list_id, list_name, created_at.
Created. Returns list_id, list_name, created_at.
Requires two headers: x-team-id and x-secret. Both must be sent with each request.
List details including contact_count.
List details including contact_count.
Requires two headers: x-team-id and x-secret. Both must be sent with each request.
200 OK on success
No content
200 OK on success
No content
Requires two headers: x-team-id and x-secret. Both must be sent with each request.
Array of strings that define the data types being passed in the Values attribute. It is acceptable to have 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)
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.
Returns accepted_count and rejected details.
Returns accepted_count and rejected details.
Invoke our brand api from your application by sending an HTTP GET containing with the attributes listed.
Requires two headers: x-team-id and x-secret. Both must be sent with each request.
Array of brands
Array of brands
Invoke our recordings api from your application by sending an HTTP GET containing with the attributes listed.
Requires two headers: x-team-id and x-secret. Both must be sent with each request.
Filter brands by whether API access has been granted or not.
Array of recordings
Array of recordings
Invoke our recordings api from your application by sending an HTTP GET containing with the attributes listed.
Requires two headers: x-team-id and x-secret. Both must be sent with each request.
Array of media
Array of media
Invoke our number pool api from your application by sending an HTTP GET containing with the attributes listed.
Requires two headers: x-team-id and x-secret. Both must be sent with each request.
Array of number pools
Array of number pools
Last updated
Was this helpful?