API Endpoint

POST

https://api.dropcowboy.com/v1/sms

---

SMS Attributes

Required Body Keys

Name

Type

Description

Required?

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: [phone]

YES

phone_number

STRING

Your contact's phone number in E.164 format.

Example: [phone]

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

Name

Type

Description

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>

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

Send SMS

post

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.

Authorizations

teamSecretAuth

x-team-id / x-secretstringRequired

Requires two headers: x-team-id and x-secret. Both must be sent with each request.

Body

application/json

team_idstring · enumRequired

Located on the API Setting tab. (Required)

Possible values:

secretstring · enumRequired

Located on the API Setting tab. (Required)

Possible values:

phone_numberstring · enumRequired

Your contact's phone number in E.164 format. (Required)

Possible values:

caller_idstring · enumRequired

The phone number to forward calls and texts to when the contact replies to your message. Must be in E.164 format. (Required)

Possible values:

pool_idstringRequired

The ID of the private number pool you registered to send SMS messages. (Required)

sms_bodystring · enum · max: 160Required

Plain text containing your message. Character limit is 160. (Required)

Possible values:

opt_inboolean · enumRequired

Confirmation that you obtained OPT-IN permission to send SMS to the recipient as required by law. (Required)

Possible values:

callback_urlstring · enumOptional

Override the default RVM webhook url that you specified in your API settings.

Possible values:

foreign_idstring · enum · max: 256Optional

A value to identify this drop in your system. Will be passed through to you in the webhook callback.

Possible values:

Responses

200

Request accepted. Results include accepted_count and rejected details.

application/json

statusstringOptional

post

/sms

HTTPcURLJavaScriptPython

POST /v1/sms HTTP/1.1
Host: api.dropcowboy.com
x-team-id / x-secret: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 230

{
  "team_id": "<Your Account>",
  "secret": "<Your Secret>",
  "phone_number": 15552223333,
  "caller_id": 15557778888,
  "pool_id": "text",
  "sms_body": "Hello world",
  "opt_in": true,
  "callback_url": "http://example.com",
  "foreign_id": "<Your system's ID>"
}

200

Request accepted. Results include accepted_count and rejected details.

{
  "status": "text"
}

---

Example Response

{ 
    "status": "queued" 
}