Send SMS To User

POST /users/{id}/send-sms
Copied
Arrow
                https://api.ocamba.com/v1/hood/users/{id}/send-sms

Sends SMS to User if a valid identifier was provided

Request Body Schema
Arrow
Name
Description
contentstringrequired
The SMS content.[string 1 .. 320].


Example: Hello from Ocamba.
integration_idstringrequired
The integration id.


Example: 1000
shorten_links[ shorten-link ]
Array of shorten link objects, maximum length is limited by content length. If a placeholder in content has less than 23 characters it will count as 23 characters.
Response status codes
Arrow
204 - No Content
Arrow
note
1 If shorten links is supplied in request, the number of elements in the array must equal the number of placeholders in content, and each placeholder must be present in content as well.
2 If shorten links is supplied in request, each placeholder in content must be wrapped in ${}.
Request examples
Copied
Arrow
200 Arrow
  • 200
{       
  "integration_id" : "1001",
  "content" : "Hello from Ocamba! Link 1: ${URL_0} Link 2: ${URL_1}"
  "shorten_links": [
      {
          "placeholder": "URL_0",
          "url": "https://ocamba.com",
          "expires_in": 17
      },
      {
          "placeholder": "URL_1",
          "url": "https://google.com",
          "expires_in": 17
      }
  ]
}