Webhooks
Drop Cowboy will notify you via webhook by http POST to the URL you specify in your API request. You will receive JSON content containing the delivery status of every voicemail you attempt to send.
Drop Cowboy will notify you via webhook by http POST to the callback_url you specify in your /rvm API request. You will receive JSON content containing the delivery status of every voicemail you attempt to send. Your server should be capable of handling a high number of concurrent requests which will scale up or down based on your sending volume. High volume senders should consider employing a queueing technology such as AWS SQS or RabbitMQ as a buffer in order to handle the potentially high concurrency calls to your callback_url coming from Drop Cowboy.
Linking Webhook Results Back to Your Database
Drop Cowboy sends a webhook response for every /rvm request that we receive. You can link the delivery results back to records in your database by passing foreign_id as part of your /rvm API request. It is common to pass a database record id that identifies the delivery attempt or other record within your system.
Example Webhook (Successful Delivery):
{
"drop_id": "5c8eb7940a057a4ab0823e1a",
"phone_number": "+15552223333",
"attempt_date": "2019-03-17T21:10:26.000Z",
"status": "success",
"reason": "",
"dnc": false,
"product_cost": 0.099,
"compliance_fee": 0.0031,
"tts_fee": 0.03,
"network": {
"name": "Verizon Wireless:6006 - SVR/2",
"type": "wireless"
},
"foreign_id": "YOUR_DATABASE_RECORD_ID"
}Example Webhook (Failed Delivery):
Possible Error Reasons
The following error codes will be returned to your webhook:
0
Delivery success
1000
Pending
Delivery pending
3000
No Funds
Your account is out of funds. Turn on auto payments and check your account balance.
3001
Audio file not valid
The audio_url or recording_id doesn't contain valid audio. Make sure the recording_id is valid or the audio_url is referencing the actual audio file and not a webpage.
3002
No Voice
The voice_id for the Mimic AI voice is not valid.
3003
Campaign Deleted
You deleted the campaign and no additional voicemails will be sent on it.
3004
Not Included in Plan
You're attempting to use a feature not included in your Drop Cowboy subscription.
3005
No Route Available
Your BYOC account is not configured to route calls to the target phone number.
3006
No Proxy Available
Your BYOC account is not configured properly. Contact support.
3007
Not authorized
You did not send valid team_id or secret API credentials.
3008
No API container
Your account is not fully configured to allow API access. Contact support.
3009
Too many phone numbers
You attempted to send more than 1 phone number in your API request.
3010
Nothing to do
You didn't send a phone number in your API request.
3011
Must be E.164 format
Your contact's phone number and your caller id / forwarding numbers must be in E.164 format.
3012
Phone number not valid
Your contact's phone number is not valid.
3013
Invalid IVR or Route
The phone_ivr_id, sms_ivr_id, or forwarding route is not valid.
3014
Not allowed audio_url
You must receive approval to use audio_url or you must use BYOC. Contact support.
3015
No TTS
You specified a voice_id but did not provide tts_body.
3016
BYOC not enabled
You attempted to use BYOC features but your account isn't configured for BYOC. Contact support.
3017
Invalid STI
Your BYOC Stir/Shaken configuration is not valid.
3018
Invalid Attestation
Your BYOC Stir/Shaken attestation is invalid. Must be "A", "B", or "C".
3019
Invalid Callback
The value you submitted for callback_url is not a valid URL.
3020
Missing Parameters
Your API request is not complete. You're missing required parameters.
3999
Other
Catch all error condition
4000
VoiceMail NotDetected
A voicemail inbox was not detected for your contact's phone number.
4001
VoiceMail NotSetup
Your contact did not setup their voicemail inbox.
4002
VoiceMail Full
Your contact's voicemail inbox is full and cannot accept new voicemails.
4003
Temporarily unreachable
Your contact's phone number is not currently reachable due to upstream issues in the public phone network.
4004
Number not reachable
Your contact's phone number is not in service.
4005
No Answer
Your contact's phone number is not voicemail enabled.
4006
User Busy
Your contact's phone number is busy.
4007
Not Mobile
Your contact's phone number is not a wireless number. Only applies if your account is configured to only deliver to mobile numbers.
4008
Spam detected
Your delivery attempt was rejected by the upstream carrier as spam.
4009
Public Safety Number
You attempted to contact a phone number that could be a public safety number.
4010
No Caller ID
The Drop Cowboy shared number pool or your private number pool (pool_id) does not contain a caller ID phone number in the contact’s country.
4011
TCPA Hours
We were unable to delivery your voicemail during a valid TCPA window of 8am to 9pm local to the contact.
4012
Timeout
The contact's voicemail box was unresponsive.
4013
Too Many Attempts
You attempted to send a voicemail to the contact more than the allowed 3 times in 3 days (default) or 7 times in 7 days (FDCPA).
4014
Duplicate delivery
We detected a duplicate delivery attempt to the same contact.
4015
United States Blocked
You attempted delivery to a phone number in the US but your account is not permitted to send to the United States. Contact support.
4016
Internal DNC
The contact's phone number is on your Drop Cowboy "Do Not Contact" list.
4017
Known Litigator
The contact's phone number is associated with a known TCPA litigator, complainant, or other blocked phone number.
4018
Invalid Privacy
The privacy setting is not valid. Must be "off" or "full".
6000
Carrier Denied Use Case
You're attempting to send message content that’s not permitted by the upstream carrier network.
6001
Carrier Suspension
Your campaign or account has been suspended due to terms of service violations.
6002
Pool Suspended
Your phone number pool has been suspended due to terms of service violations.
6003
Pool Not Ready
You're attempting to send from private number pool or account that has not completed compliance / trust center verification.
6004
Opt-in Flagged
You attempted to send from an account, campaign, or number pool that's been flagged as not having TCPA approved opt-in.
6005
Opt-in Revoked
The contact revoked consent to be contacted.
6006
Opt-in Pending
The contact has not yet consented to be contacted.
6007
Must Use Number Pool
You must specify pool_id for your use case.
6008
Must Use Compliant Number Pool
The pool_id you specified is not approved for 10DLC.
6009
Unregistered Brand
The brand_id you specified is invalid or had not completed a compliance review in the trust center.
6010
Unregistered Recording
The recording_id you specified is not valid or has not completed a compliance review. Please submit the recording for review.
Last updated
Was this helpful?