User.com REST API Docs

# Get single SMS campaign

You can return details about a specific SMS campaign.

GET /sms-campaign/:id

Attributes Type Required Description
id integer yes A unique identifier for the campaign which is given by User.com automatically.

# Request

  • CURL
  • JavaScript
  • PHP
  • Python 
curl -X GET -H "Authorization: Token <your_64_char_api_key>"
-H "Accept: */*; version=2" 
-H "Accept: */*; version=2" "https://<your_app_subdomain>.user.com/api/public/sms-campaign/:id"

# Response

{
  "id": 2,
  "name": "",
  "description": "",
  "phone_number": {
      "id": 3,
      "provider": "Twilio",
      "country": "",
      "phone_number": "500100101",
      "name": "PhoneNumber1",
      "description": "",
      "sms": false,
      "voice": false,
      "price": "0.00",
      "last_used_at": null,
      "created_at": "2020-03-02T16:03:56.006762Z",
      "updated_at": "2020-03-02T16:03:56.030803Z",
      "record_incoming_calls": false
  },
  "type": 1,
  "eta": null,
  "status": 1,
  "recipients": null,
  "recipients_ids": null,
  "recipients_count": null,
  "started_at": null,
  "last_message_sent_at": null,
  "finished_at": null,
  "author": 1,
  "created_at": "2020-03-02T16:06:27.000183Z",
  "updated_at": "2020-03-02T16:06:27.000204Z",
  "statistics": {
      "delivery_percentage": 0,
      "scheduled": 0,
      "delivered": 0
  }
}

← Remove SMS campaign →