Send SMS

Understanding ids

The ids is a list of on_prem_ids which are identifier retrieved from the sim endpoint. This unique ID is essential for various operations as it needs to be specified within the parameters object when making requests. It ensures that the actions executed are accurately targeted, particularly in environments with multiple on-premise devices. Always ensure that you use the correct on_prem_id to prevent any unintended changes.

Send SMS

post

This API is used to send an SMS message to a phone number (Not available for Android Agents)

Authorizations

JWT

HTTPRequired

Enter token as: Bearer

Body

application/json

command_namestringRequiredExample: send_sms

friendly_namestringRequired

Name that will be displayed in the UI

Example: Send SMS

serverstringRequiredExample: d3505309-11b9-40ba-81c9-c0a96e195ea3

Responses

201Success

application/json

post

/task/send-sms

HTTPcURLJavaScriptPython

POST /api/v1/task/send-sms HTTP/1.1
Host: api.proxidize.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 179

{
  "command_name": "send_sms",
  "friendly_name": "Send SMS",
  "parameters": {
    "ids": [
      1
    ],
    "recipient": "[phone]",
    "message": "Hello, world!"
  },
  "server": "d3505309-11b9-40ba-81c9-c0a96e195ea3"
}

201Success

{
  "id": 1,
  "user": 1,
  "server": "text",
  "client": 1,
  "logged": true,
  "status": "text",
  "tagged": true,
  "timeout": 1,
  "broadcast": true,
  "created_at": "text",
  "parameters": {},
  "user_email": "text",
  "server_name": "text",
  "command_name": "text",
  "friendly_name": "text",
  "server_response": {},
  "timeout_remaining": "text"
}